WebSphinx uses the keyword (reserved word); most of the programming language does. But it is explicitly called role in Sphinx. In the above code, Sphinx has the param as a role, and type is a role, which is the Sphinx data type for param. type role is optional, but param is mandatory. The return roles document the returned object. WebSee also. To structure single and multiple documents into table of contents, see the organising content section. To reference a heading in your text, see the cross-referencing section. 2. Paragraphs #. Paragraphs are block of text separated by a blank line.
Math support in Sphinx — Sphinx 1.2 documentation
WebWithin a math expression, add a \ symbol before the explicit $. This expression uses `\$` to display a dollar sign: $\sqrt {\$4}$ Outside a math expression, but on the same line, use span tags around the explicit $. To split $100 in half, we calculate $100/2$ Further reading The MathJax website WebMath support in Sphinx. ¶. New in version 0.5. Since mathematical notation isn’t natively supported by HTML in any way, Sphinx supports math in documentation with two extensions. The basic math support that is common to both extensions is contained in sphinx.ext.mathbase. Other math support extensions should, if possible, reuse that … plug-in hybrid privatleasing
Math support in Sphinx - Sphinx Documentation
http://docs.mathjax.org/en/latest/basic/mathjax.html WebExample Google Style Python Docstrings. Download: example_numpy.py. # -*- coding: utf-8 -*- """Example NumPy style docstrings. This module demonstrates documentation as specified by the `NumPy Documentation HOWTO`_. Docstrings may extend over multiple lines. Sections are created with a section header followed by an underline of equal length. WebThere are multiple ways to show syntax-highlighted literal code blocks in Sphinx: using reST doctest blocks; using reST literal blocks, optionally in combination with the highlight directive; using the code-block directive; and using the literalinclude directive. plug in hybrid scooter