:py:mod:`skeleton.demo_directive` ================================= .. py:module:: skeleton.demo_directive .. autoapi-nested-parse:: Demonstration of a custom directive for sphinx. This directive should be deleted when starting a new extension but it gives an overview of the different steps to follow to create a new directive. It is also used to demonstrate the documentation/test workflows. .. note:: We only coded a html output for this directive. Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: skeleton.demo_directive.DemoDirective Attributes ~~~~~~~~~~ .. autoapisummary:: skeleton.demo_directive.logger .. 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:data:: logger