summaryrefslogtreecommitdiff
path: root/doc/development/tutorials
diff options
context:
space:
mode:
authorArtFlag <arthur.flageul@gmail.com>2018-12-19 17:33:22 +0100
committerArtFlag <arthur.flageul@gmail.com>2018-12-19 17:35:17 +0100
commit990b02b5fbfc588d0623d0e8551a4b4c6ce3f0ce (patch)
treee3cafaf0a52c9f2788abb74c7abf73b1bdd7da7e /doc/development/tutorials
parent870e2bbc1c2c62d848c09d323b08493b6dd400e9 (diff)
downloadsphinx-git-990b02b5fbfc588d0623d0e8551a4b4c6ce3f0ce.tar.gz
Feedback
Diffstat (limited to 'doc/development/tutorials')
-rw-r--r--doc/development/tutorials/helloworld.rst42
1 files changed, 27 insertions, 15 deletions
diff --git a/doc/development/tutorials/helloworld.rst b/doc/development/tutorials/helloworld.rst
index 0c37f38f6..3769edcdb 100644
--- a/doc/development/tutorials/helloworld.rst
+++ b/doc/development/tutorials/helloworld.rst
@@ -61,7 +61,7 @@ in all directives:
.. rubric:: Directive declaration
-Our new directive is declared in the :code:`HelloWorld` class, it extends
+Our new directive is declared in the ``HelloWorld`` class, it extends
docutils_' code:`Directive` class. All extensions that create directives
should extend this class.
@@ -73,7 +73,7 @@ be processed by Sphinx.
.. seealso::
- :ref:`exttuto-todo`.
+ :doc:`todo`
.. rubric:: docutils nodes
@@ -81,27 +81,33 @@ 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.
-Read more about `docutils nodes`_.
+.. seealso::
-You can also create your own nodes if needed, refer to the
-:ref:`exttuto-todo` for more information.
+ `docutils nodes`_
-The :code:`nodes.paragraph` method creates a new paragraph node. A paragraph
+The ``nodes.paragraph`` class creates a new paragraph node. A paragraph
node typically contains some text that we can set during instantiation using
the ``text`` parameter.
-.. rubric:: `setup` method
+.. rubric:: ``setup`` function
+
+This function is a requirement. We use it to plug our new directive into
+Sphinx.
+The simplest thing you can do it call the ``app.add_directive`` method.
-This method is a requirement. We use it to plug our new directive into
-Sphinx. The first argument is the name of the directive itself. In our case:
+.. note::
-.. code-block:: rst
+ The first argument is the name of the directive itself as used in an rST file.
+
+ In our case, we would use ``helloworld``:
+
+ .. code-block:: rst
- Some intro text here...
+ Some intro text here...
- .. helloworld::
+ .. helloworld::
- Some more text here...
+ Some more text here...
Updating the conf.py file
@@ -111,9 +117,9 @@ The extension file has to be declared in your :file:`conf.py` file to make
Sphinx aware of it:
#. Open :file:`conf.py`. It is in the :file:`source` folder by default.
-#. Add :code:`sys.path.append(os.path.abspath("./_ext"))` before
+#. Add ``sys.path.append(os.path.abspath("./_ext"))`` before
the ``extensions`` variable declaration (if it exists).
-#. Update of create the ``extensions`` list and add the
+#. Update or create the ``extensions`` list and add the
extension file name to the list:
.. code-block:: python
@@ -146,5 +152,11 @@ This is the very basic principle of an extension that creates a new directive.
For a more advanced example, refer to :ref:`exttuto-todo`
+Further reading
+---------------
+
+You can create your own nodes if needed, refer to the
+:ref:`exttuto-todo` for more information.
+
.. _docutils: http://docutils.sourceforge.net/
.. _`docutils nodes`: http://docutils.sourceforge.net/docs/ref/doctree.html \ No newline at end of file