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

ability to write docs in Markdown (.md) instead of reStructuredText (.rst) #10111

Closed
pdurbin opened this issue Nov 9, 2023 · 1 comment · Fixed by #10103
Closed

ability to write docs in Markdown (.md) instead of reStructuredText (.rst) #10111

pdurbin opened this issue Nov 9, 2023 · 1 comment · Fixed by #10103

Comments

@pdurbin
Copy link
Member

pdurbin commented Nov 9, 2023

It would be nice to be able to write documentation in Markdown (.md) instead of reStructuredText (.rst).

I'm planning to add Markdown support into this PR:

pdurbin added a commit that referenced this issue Nov 9, 2023
We don't seem to be using intersphinx and I got an error about it so i
simply removed it.

I also got rid of the Python 3.10 vs 3.11 divide. It's no longer
relevant and some older servers were holding us back. Everyone should
use the same (latest!) Sphinx.

I included a tiny conclusion.md file as a demo, but it can be removed,
of course.
@pdurbin
Copy link
Member Author

pdurbin commented Nov 9, 2023

I added Markdown support in d32446e in that PR I mentioned:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant