Docs: Create overview page of extensions

[EwoutH]

• Mesa-Geo
• Mesa-Examples

And possibly in the future

• Mesa-frames
• Mesa-RL

[wang-boyu]

In readthedocs or GitHub wiki? We have this page at the moment: https://github.com/projectmesa/mesa/wiki/Mesa-Packages

[EwoutH]

Oh that’s already quite good, then I think we can just add it to the Readthedocs.

[JayaLakshmiPilla]

Good Evening ! I want to contribute to this organization but I'm not getting how to start my work . Kindly anyone can help me get out of this.

[EwoutH]

I created a new discussion for this:

• https://github.com/projectmesa/mesa/discussions/2201

[ENUMERA8OR]

@EwoutH I would like to contribute to this issue.

[PrashantChoudhary13579]

@EwoutH I would be very thankful to you if you assign this issue to me , as it seems to the beginning for me in this project mesa as a contributor... Should i work upon it ? As I am having an architecture, how to solve this problem

[EwoutH]

Sure! Before opening a PR, please first propose to us an exact place in the ReadtheDocs where you want to add this page, than we can make sure it's directly added where we want it.

[PrashantChoudhary13579]

I am having bit confusion, Can you clear it out ? @wang-boyu was saying that we are already having a page in Github wiki as mentioned above, I explored it and found that it does not contain any Mesa-Examples , Mesa-frames, etc So I was thinking that we can create a new page Titled as "Overview of Mesa Extensions" and add those things in it. What do you think which idea is better - Making a new page or Modifying the Github wiki page

In the readthedocs, it can be added in Resources after Mesa Examples

[PrashantChoudhary13579]

Hello @EwoutH I have made a page of Mesa's Extensions but I am having some doubts. Can you please solve them.

1. I have added Mesa-Geo, Mesa-Examples, and Mesa-Frames in it. Should I have to add the mesa-RL ? If so, please provide me the repo link or is this mesa-RL link ?
2. Another question is that, please tell me if any another extension has to be added in it ?
3. While I was trying to build, I was facing some error -

 Encoding error:
'charmap' codec can't decode byte 0x9d in position 1379: character maps to <undefined>

But i solved it by adding and modifying some lines of code in conf.py located in docs file

# Adding these lines 

if sys.version_info >= (3,):
    from sphinx.util import logging
    logger = logging.getLogger(__name__)
os.environ['PYTHONIOENCODING'] = 'utf-8'

.
.
.
.
.
.
# modifying the lines with adding - encoding= 'utf-8' inside the with open bracket 

def write_example_md_file(agent_filename, model_filename, readme_filename, app_filename, md_filepath, template):
    with open(agent_filename, encoding='utf-8') as content_file:
        agent_file = content_file.read()
    with open(model_filename, encoding='utf-8') as content_file:
        model_file = content_file.read()
    with open(readme_filename, encoding='utf-8') as content_file:
        readme_file = content_file.read()
    with open(app_filename, encoding='utf-8') as content_file:
        app_file = content_file.read()

    with open(md_filepath, "w", encoding='utf-8') as fh:
        content = template.substitute(
            dict(agent_file=agent_file, model_file=model_file,
                 readme_file=readme_file, app_file=app_file)
        )
        fh.write(content)

So my doubt for this is related to when i make a PR then , should i commit all the changes i have made including the above which i have done for my building process or i have to commit that is general ( making the extension file and updating the readthedocs file)

Waiting for the response

[tpike3]

@PrashantChoudhary13579 That is the RL Link

I would NOT add this code

if sys.version_info >= (3,):
    from sphinx.util import logging
    logger = logging.getLogger(__name__)
os.environ['PYTHONIOENCODING'] = 'utf-8'

I think this is a dynamic with your local machine, after you do the PR update you can check the build in the checks to see if it passed or got the same error.

Let me know if this answers your questions or if there is anything else

[Edu92337]

Hey @PrashantChoudhary13579, I would like to contribute to this issue. Could you assign it to me?

[Sahil-Chhoker]

Hey @Edu92337, thanks for your interest in solving this issue but it is already solved by the PR #2627.