Directives — Sphinx documentation

Since reStructuredText does not have facilities to interconnect several documents, or split documents into multiple output files, Sphinx uses a custom directive ...

Directives - Sphinx documentation

Since reST does not have facilities to interconnect several documents, or split documents into multiple output files, Sphinx uses a custom directive to add ...

reStructuredText Primer — Sphinx documentation

Directives¶ · 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 ...

Sphinx Directives and Roles

Contents: Documentation in Python Open Source Community · Building a Documentation Project with Sphinx · reStructuredText; Sphinx Directives and Roles; Sphinx ...

Source code for sphinx.directives

flag, 'noindex': directives.flag, 'noindexentry': directives.flag, 'nocontentsentry': directives.flag, } # types of doc fields that this directive handles ...

Directives — Sphinx-lesson documentation - CodeRefinery

Directives . See also. In Sphinx/Docutils, directives have a different meaning. Directives in sphinx-lesson are actually the special case of the generic ...

Extending syntax with roles and directives — Sphinx documentation

Using the extension¶. The extension has to be declared in your conf.py file to make Sphinx aware of it. There are two steps necessary here: ... Because we haven't ...

How to create custom directives in Sphinx - python - Stack Overflow

1 Answer 1 ... Sphinx can be extended with custom directives via "Sphinx Extensions". That is, you will need to implement a Sphinx extension ...

sphinx/sphinx/directives/other.py at master - GitHub

File metadata and controls ... Directive to notify Sphinx about the hierarchical structure of the docs,. and to include a table-of-contents like tree in the ...

Docutils markup API — Sphinx documentation

Directives are handled by classes derived from docutils.parsers.rst.Directive . They have to be registered by an extension using Sphinx.add_directive() or ...

Directives — Sphinx-lesson documentation - CodeRefinery

Directives¶. We have the following directives available: ... Directives are implemented in the Python package sphinx_lesson.directives and can be used ...

Extending the build process — Sphinx documentation

Whereas that guide just covered writing a custom role and directive, this guide covers a more complex extension to the Sphinx build process; adding multiple ...

reStructuredText markup - Python Developer's Guide

Sphinx adds a lot of new directives and interpreted text roles to standard reST markup. This section contains the reference material for these facilities.

important — reStructuredText and Sphinx Reference - Documatt

Directive name is case insensitive (like all directive and role names). Most documentation and book authors prefer typing directives and roles all in lowercase.

reStructuredText Directives - Docutils

code:: python :number-lines: def my_function ... Sphinx rather than the "header" and "footer" directives. ... See the writer specific documentation in the user doc ...

The reStructuredText Domain - rst:directive - Sphinx

Describes a reStructuredText directive. The name can be a single directive name or actual directive syntax ( .. prefix and :: suffix) with arguments that will ...

Introduction to Sphinx - Write the Docs

For example, Sphinx includes directives to relate documentation of modules, classes and methods to the corresponding code. Installing Sphinx¶. The first step ...

Sphinx Documentation - Read the Docs

Sphinx is a documentation generator or a tool that translates a set of plain text source files into various output formats,.

contents — reStructuredText and Sphinx Reference - Documatt

The directive's main purpose is to print a document's ToC in the document body, but many Sphinx themes has “on this page” sidebar that shows current document's ...

IPython Sphinx Directive - Jupyter Documentation

The state from previous sessions is stored, and standard error is trapped. At doc build time, ipython's output and std err will be inserted, and prompts will be ...