Over the last couple weeks I wrote some extensive documentation for an Open Source project, and I ended up using mkdocs published to github pages when I commit, via
github-actions. That's been a really spectacular experience.
About half of the docs are just direct Markdown, and the other half are in python docstrings, pulled by mkdocs automatically. The "mkdocs serve" dev server works amazingly well for visualizing changes. Highly recommended.
About half of the docs are just direct Markdown, and the other half are in python docstrings, pulled by mkdocs automatically. The "mkdocs serve" dev server works amazingly well for visualizing changes. Highly recommended.