Documentation tutorial¶
Our favorite document generator is sphinx and we use the reStructuredText markup.
- Documentation news
- Documentation Advices
- You are what you document (Monday, May 5, 2014)
- Rédaction technique
- 13 Things People Hate about Your Open Source Docs
- Beautiful docs
- Designing Great API Docs (11 Jan 2012)
- Docness
- Hacking distributed (february 2013)
- Jacob Kaplan-Moss (November 10, 2009)
- Agile documentation best practices
- Best Practices for Documenting Technical Procedures Melanie Seibert
- Plone
- Twilio
- Other advices
- Documentation generators
- Sphinx
- Description
- Sphinx source code (Sphinx dev guide)
- Sphinx applications
- reST Sphinx
- Sphinx extensions (sphinx.ext.*)
- Sphinx contributed extensions
- Sphinx howto
- Sphinx examples
- Sphinx i18n
- Sphinx builders
- Sphinx installation
- Sphinx usage
- Sphinx people
- Sphinx tutorials
- Tools for Sphinx
- Sphinx themes
- Sphinx templating
- Sphinx translations
- Sphinx versions
- Authorea
- Doxygen
- gatsby (Build blazing fast, modern apps and websites with React), graphQL Foundation member
- Hugo (The world’s fastest framework for building websites)
- Javadoc
- Jekyll
- JSDoc
- mdbook
- Mkdocs
- Pandoc
- pdoc (Auto-generate API documentation for Python projects)
- redoc
- swagger-ui
- Sphinx
- Sphinx documentation hosting
- Good documentation
- Formats Documentation
- Documentation projects
- Documentation tools
- Documentation videos
- Wiki documentation