move files to new directory

This commit is contained in:
ArtFlag 2018-12-19 16:45:15 +01:00
parent adc1d2b59d
commit 870e2bbc1c
5 changed files with 9 additions and 12 deletions

View File

@ -25,7 +25,7 @@ Sphinx documentation contents
templating
latex
extdev/index
extdev/tutorials/index
development/tutorials/index
faq
glossary

View File

@ -1,5 +1,3 @@
.. _exttuto-helloworld:
Developing a "Hello world" directive
====================================
@ -7,7 +5,7 @@ The objective of this tutorial is to create a very basic extension that adds a n
directive that outputs a paragraph containing `hello world`.
Only basic information is provided in this tutorial. For more information,
refer to the :ref:`other tutorials <extensiontutos>` that go into more
refer to the :doc:`other tutorials <index>` that go into more
details.
.. warning:: For this extension, you will need some basic understanding of docutils_
@ -67,17 +65,19 @@ Our new directive is declared in the :code:`HelloWorld` class, it extends
docutils_' code:`Directive` class. All extensions that create directives
should extend this class.
.. rubric:: `run` method
.. rubric:: ``run`` method
This method is a requirement and it is part of every directive. It contains
the main logic of the directive and it returns a list of docutils nodes to
be processed by Sphinx.
Read more on this topic in :ref:`exttuto-todo`.
.. seealso::
:ref:`exttuto-todo`.
.. rubric:: docutils nodes
The `run` method returns a list of nodes. Nodes are docutils' way of
The ``run`` method returns a list of nodes. Nodes are docutils' way of
representing the content of a document. There are many types of nodes
available: text, paragraph, reference, table, etc.

View File

@ -1,5 +1,3 @@
.. _extensiontutos:
Extension tutorials
===================
@ -9,5 +7,5 @@ Refer to the following tutorials to get started with extension development.
:caption: Directive tutorials
:maxdepth: 1
helloworld_ext
todo_ext
helloworld
todo

View File

@ -84,7 +84,6 @@ APIs used for writing extensions
.. toctree::
:maxdepth: 2
tutorials/index
appapi
projectapi
envapi