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 If you are new to Sphinx, we recommend starting with Get started
Getting started — Sphinx documentation Much of Sphinx’s power comes from the richness of its default plain-text markup format, reStructuredText, along with its significant extensibility capabilities The goal of this document is to give you a quick taste of what Sphinx is and how you might use it
Installing Sphinx — Sphinx documentation Installing Sphinx¶ Sphinx is a Python application It can be installed in one of the ways described below Installation methods PyPI package Conda package OS-specific package manager Linux macOS Windows Docker Installation of the latest development release Installation from source After installation, you can check that Sphinx is
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 Sphinx provides yet another level of automation: the autosummary extension
Cross-references — Sphinx documentation One of Sphinx’s most useful features is creating automatic cross-references through semantic cross-referencing roles A cross reference to an object description, such as :func:`spam`, will create a link to the place where spam() is documented, appropriate to each output format (HTML, PDF, ePUB, etc ) Syntax¶
Sphinx documentation contents 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 in the documentation; sphinx ext duration – Measure durations of Sphinx processing; sphinx ext extlinks – Markup to shorten
Appendix: Deploying a Sphinx project online Since the HTML generated by Sphinx is static, you can decouple the process of building your HTML documentation from hosting such files in the platform of your choice You will not need a sophisticated server running Python: virtually every web hosting service will suffice
Changelog — Sphinx documentation Changelog¶ Release 8 3 0 (in development)¶ Dependencies¶ Incompatible changes¶ Deprecated¶ 13627: Deprecate remaining public app attributes, including builder
Domains — Sphinx documentation This section describes what the domains that are included with Sphinx provide The domain API is documented as well, in the section Domain API Basic Markup ¶
Configuration — Sphinx documentation This file (containing Python code) is called the “build configuration file” and contains (almost) all configuration needed to customise Sphinx input and output behaviour An optional file docutils conf can be added to the configuration directory to adjust Docutils configuration if not otherwise overridden or set by Sphinx