diff options
| author | ArtFlag <arthur.flageul@gmail.com> | 2018-12-19 16:45:15 +0100 |
|---|---|---|
| committer | ArtFlag <arthur.flageul@gmail.com> | 2018-12-19 17:35:17 +0100 |
| commit | 870e2bbc1c2c62d848c09d323b08493b6dd400e9 (patch) | |
| tree | cbba15452c737b7d0fb7986cd9cf6e35b6e531ac | |
| parent | adc1d2b59dc6621379ecc9f0c9e6fc10b3c4ab36 (diff) | |
| download | sphinx-git-870e2bbc1c2c62d848c09d323b08493b6dd400e9.tar.gz | |
move files to new directory
| -rw-r--r-- | doc/contents.rst | 2 | ||||
| -rw-r--r-- | doc/development/tutorials/helloworld.rst (renamed from doc/extdev/tutorials/helloworld_ext.rst) | 12 | ||||
| -rw-r--r-- | doc/development/tutorials/index.rst (renamed from doc/extdev/tutorials/index.rst) | 6 | ||||
| -rw-r--r-- | doc/development/tutorials/todo.rst (renamed from doc/extdev/tutorials/todo_ext.rst) | 0 | ||||
| -rw-r--r-- | doc/extdev/index.rst | 1 |
5 files changed, 9 insertions, 12 deletions
diff --git a/doc/contents.rst b/doc/contents.rst index 338be767d..f3a1cd2f8 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -25,7 +25,7 @@ Sphinx documentation contents templating latex extdev/index - extdev/tutorials/index + development/tutorials/index faq glossary diff --git a/doc/extdev/tutorials/helloworld_ext.rst b/doc/development/tutorials/helloworld.rst index 62a50bd19..0c37f38f6 100644 --- a/doc/extdev/tutorials/helloworld_ext.rst +++ b/doc/development/tutorials/helloworld.rst @@ -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. diff --git a/doc/extdev/tutorials/index.rst b/doc/development/tutorials/index.rst index 5a9e9d89e..cb8dce435 100644 --- a/doc/extdev/tutorials/index.rst +++ b/doc/development/tutorials/index.rst @@ -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 diff --git a/doc/extdev/tutorials/todo_ext.rst b/doc/development/tutorials/todo.rst index ec5081dc5..ec5081dc5 100644 --- a/doc/extdev/tutorials/todo_ext.rst +++ b/doc/development/tutorials/todo.rst diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index f87021fe5..809ea1220 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -84,7 +84,6 @@ APIs used for writing extensions .. toctree:: :maxdepth: 2 - tutorials/index appapi projectapi envapi |