Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Convert visualization .rst -> .md via rst2myst #2036

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Conversation

rht
Copy link
Contributor

@rht rht commented Feb 16, 2024

This has been brought up in dev meetings for a while, to have 1 format for documentation everywhere, not a mixture of .rst and .md. This is actually a long overdue change; @tpike3 could confirm this. The secondary reason is I want to try ChatGPT in making the docs clearer and more concise. See #2037.

Copy link
Member

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

On https://mesa--2036.org.readthedocs.build/en/2036/apis/visualization.html clickable links seem to be missing.

Please add a PR description for historical reference.

@rht
Copy link
Contributor Author

rht commented Feb 16, 2024

Added PR description.

On https://mesa--2036.org.readthedocs.build/en/2036/apis/visualization.html clickable links seem to be missing.

It's already the case previously. See https://mesa--2024.org.readthedocs.build/en/2024/apis/visualization.html.

@rht rht merged commit d65f41c into projectmesa:main Feb 21, 2024
3 checks passed
@rht rht deleted the docs4 branch February 21, 2024 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants