Main / Family / Sphinx directive
Name: Sphinx directive
File size: 849mb
This directive inserts a “TOC tree” at the current location, using the individual TOCs (including “sub-TOC trees”) of the documents given in the directive body. function is the directive name. It is given two arguments here, the remainder of the first line and the second line, as well as one option module (as you can see. A “todo” directive, containing some content that is marked with “TODO”, and only shown in the output if a new config value is set. (Todo entries should not be in.
This directive documents the version of the project which added the described feature to the library or C API. When this applies to an entire module, it should be . A domain is a collection of markup (reStructuredText directives and roles) to describe and link to objects belonging together, e.g. elements of a programming . The codeauthor directive, which can appear multiple times, names the authors of the described code, just like sectionauthor names the author(s) of a piece of.
For documents that have to show snippets in different languages, there's also a code-block directive that is given the highlighting language directly. The same works for tables that are given an explicit caption using the table directive. Labels that aren't placed before a section title can still be referenced, but. Custom Directive on Sphinx. I recently discovered a nice way to integrate plots in sphinx documentation with the custom directive bokeh-plot. For directive implementation details, see Creating reStructuredText Directives. .. generator like Sphinx rather than the "header" and "footer" directives. Sphinx and the RST syntax provides directives to include formatted text. As an example, let us consider the code-block syntax. It allows to insert code (here.