-
Notifications
You must be signed in to change notification settings - Fork 121
Migrate documentation to use Markdown and MkDocs #1397
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
Conversation
…ocumentation TODO: 1. Finish correcting translation - I stopped at features/disable_commands 2. Get all the autodoc API stuff working properly 3. Get ReadTheDocs working properly
Also fixed Markdown syntax in a lot more files
…PI Reference It was failing to build on ReadTheDocs with MkDocs
@kotfu @kmvanbrunt This PR is now ready for your review. Everything appears to work and I'm happy with the way it looks. I think there is a tremendous amount of room for further improvement down the road given the overall capabilities of the MkDocs Material Theme, but this seems like a great start. |
The docs this PR generates can be viewed as built by ReadTheDocs here. They are fully working other than the search - ReadTheDocs serves PR builds from a different domain than normal which is why I think that is broken. It should work in an actual build off the master branch. There is a little button in the top center that looks like a sun or moon which you can use toggle between dark and light mode and your browser will remember the setting for the same page if viewed again. |
Migrate documentation to use MkDocs with the Material Theme for the build. Replaced all use of reStructuredText with Markdown and all use of Sphinx with MkDocs.
TODO:
pandoc
mkdocstring
scripting.md
Closes #1396