list-restructuredtext-support.rst

orphan

List of ReST directives

List of ReST directives and status whether they are supported or unsupported by PyDoctor

Directive	Defined by	Supported
.. include::	docutils	Yes
.. contents::	docutils	Yes
.. image::	docutils	Yes
.. |time| date:: %H:%M	docutils	Yes
.. figure::	docutils	Yes
.. |T| replace:: term	docutils	Yes
.. unicode::	docutils	Yes
.. raw::	docutils	Yes
.. class::	docutils	No
.. role::	docutils	Yes
.. default-role::	docutils	Should not be changed.
.. line-block::	docutils	No
.. code::	docutils	Yes (No options supported)
.. python::	pydoctor	Yes
.. math::	docutils	Yes
.. highlights::	docutils	No
.. pull-quote::	docutils	No
.. container::	docutils	Yes
.. table::	docutils	Yes
.. csv-table::	docutils	Yes
.. list-table::	docutils	Yes
.. warning:: and other admonitions	docutils	Yes. This includes: attention, caution, danger, error, hint, important, note, tip, warning and the generic admonitions.
.. versionadded::	Sphinx	Yes
.. versionchanged::	Sphinx	Yes
.. deprecated::	Sphinx	Yes
.. centered::	Sphinx	No
.. digraph::	epydoc	No
.. classtree::	epydoc	No
.. packagetree::	epydoc	No
.. importgraph::	epydoc	No
.. callgraph::	epydoc	No
.. hlist::	Sphinx	No
.. highlight::	Sphinx	No
.. code-block::	Sphinx	Yes (No options supported)
.. literalinclude::	Sphinx	No
.. glossary::	Sphinx	No
.. index::	Sphinx	No
.. sectionauthor::	Sphinx	No
.. codeauthor::	Sphinx	No
.. topic::	docutils	No
.. sidebar::	docutils	No
.. rubric::	docutils	No
.. epigraph::	docutils	No
.. compound::	docutils	No
.. sectnum::	docutils	No
.. header::	docutils	No
.. footer::	docutils	No
.. meta::	docutils	No
.. title::	docutils	No

This list is not exhaustive