copy and paste this google map to your website or blog!
Press copy button and paste into your blog or website.
(Please switch to 'HTML' mode when posting into your blog. Examples: WordPress Example, Blogger Example)
Sphinx — Sphinx documentation These sections cover various topics in using and extending Sphinx for various use-cases They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx
Getting started — Sphinx documentation The goal of this document is to give you a quick taste of what Sphinx is and how you might use it When you’re done here, you can check out the installation guide followed by the intro to the default markup format used by Sphinx, reStructuredText
Installing Sphinx — Sphinx documentation You may install a global version of Sphinx into your system using OS-specific package managers However, be aware that this is less flexible and you may run into compatibility issues if you want to work across different projects
Build your first project — Sphinx documentation In this tutorial you will build a simple documentation project using Sphinx, and view it in your browser as HTML The project will include narrative, handwritten documentation, as well as autogenerated API documentation
Sphinx documentation contents sphinx ext apidoc – Generate API documentation from Python packages sphinx ext autodoc – Include documentation from docstrings sphinx ext autosectionlabel – Allow referencing sections by their title sphinx ext autosummary – Generate autodoc summaries sphinx ext coverage – Collect doc coverage stats sphinx ext doctest – Test snippets
Cross-references — Sphinx documentation Sphinx supports various cross-referencing roles to create links to other elements in the documentation In general, writing :role:`target` creates a link to the object called target of the type indicated by role
Automatic documentation generation from code - Sphinx doc While using sphinx ext autodoc makes keeping the code and the documentation in sync much easier, it still requires you to write an auto* directive for every object you want to document
Extensions — Sphinx documentation Since many projects will need special features in their documentation, Sphinx allows adding “extensions” to the build process, each of which can modify almost any aspect of document processing
Projects using Sphinx — Sphinx documentation This is an incomplete list of projects that use Sphinx for their documentation If you would like to add a project, please create an issue or pull request on GitHub