Good docs ¶
-
Diátaxis Framework A systematic framework for technical documentation authoring by Daniele Procida
-
http://brikis98.blogspot.de/2014/05/you-are-what-you-document.html
- Intro to Documentation with Sphinx and reStructuredText’s
- geopandas
- cakephp documentation
- Sphinx CDS ( Climate Data Store ) toolbox documentation
- Diátaxis Framework A systematic framework for technical documentation authoring by Daniele Procida
- Fastapi (from Sebastián Ramírez)
- Mattermost
-
poliastro - Astrodynamics in Python
- 1 All its documentation is written in Markdown using MyST (https://myst-parser.readthedocs.io) 🤯)
- 2. It has plenty of amazing math formulas nicely rendered using nbsphinx)
- 3. Gallery full of examples using “poliastro” itself created with “nbsphinx”)
- 4. INTERACTIVE 3D PLOTS WITH PLOTLY
- 5. Nice 404 Not Found pages using “sphinx-notfound-page”
- 6. Massive usage of tooltips via “sphinx-hoverxref” (https://sphinx-hoverxref.readthedocs.io) to not lose context while you are reading
- 7. Pretty nice split of pages following the concepts behind Diátaxis (https://diataxis.fr) to find out immediately what you are looking for! Split in these sections: Tutorials, How-To guides, Reference, Background, Links ✍️
- pretalx (Conference planning tool: CfP, scheduling, speaker management)
- ray
- Sfepy documentation
- Sphinx-material (by Kevin Sheppard)
- vsketch (for the API)