:py:mod:`skeleton` ================== .. py:module:: skeleton .. autoapi-nested-parse:: The init file of the extension. This is where the extension is loaded and the sphinx builder is extended. Submodules ---------- .. toctree:: :titlesonly: :maxdepth: 1 demo_directive/index.rst demo_role/index.rst Package Contents ---------------- Classes ~~~~~~~ .. autoapisummary:: skeleton.DemoDirective skeleton.DemoRole skeleton.demo_node Functions ~~~~~~~~~ .. autoapisummary:: skeleton.setup Attributes ~~~~~~~~~~ .. autoapisummary:: skeleton._NODE_VISITORS skeleton.__author__ skeleton.__email__ skeleton.__version__ .. py:class:: DemoDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine) Bases: :py:obj:`sphinx.util.docutils.SphinxDirective` A demo directive simply setting the text in bold. .. py:attribute:: arguments :value: 1 .. py:attribute:: final_argument_whitespace :value: False .. py:attribute:: has_content :value: True .. py:method:: run() Create the demo directive output. .. py:class:: DemoRole Bases: :py:obj:`sphinx.util.docutils.SphinxRole` The demo sphinxrole interpreter. .. py:method:: run() Setup the role in the builder context. .. py:class:: demo_node(rawsource='', *children, **attributes) Bases: :py:obj:`docutils.nodes.General`, :py:obj:`docutils.nodes.Element` The demo node. .. py:function:: setup(app) Add icon node to the sphinx builder. .. py:data:: _NODE_VISITORS .. py:data:: __author__ :value: 'Firstname Lastname' .. py:data:: __email__ :value: 'firstname.lastname@domain.io' .. py:data:: __version__ :value: '0.0.2'