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

Switch documentation generator/host? #207

Open
billbrod opened this issue May 12, 2023 · 1 comment
Open

Switch documentation generator/host? #207

billbrod opened this issue May 12, 2023 · 1 comment

Comments

@billbrod
Copy link
Collaborator

Documentation has two decision points: generator and host. For generator, the choices are mkdocs and sphinx. For host, github-pages or readthedocs.

I think switching from sphinx to mkdocs is worth doing, because it handles notebooks in a cleaner way and uses markdown by default. Has a similar mkdocs gallery and ability to generate from plots.

For gh-pages vs readthedocs: gh-pages consolidates all actions onto github and makes it a bit simpler. readthedocs requires an extra step to link, but allows for building preview documentation for each pull request, which is worth it.

@billbrod
Copy link
Collaborator Author

billbrod commented Aug 1, 2023

I'm now leaning towards sticking with sphinx (because it's more robust, more plugins, has been around for longer) but switching to markdown, and so using the Myst parser

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

No branches or pull requests

1 participant