diff options
author | Christian Ehrhardt <christian.ehrhardt@canonical.com> | 2019-07-04 10:40:06 +0200 |
---|---|---|
committer | Christian Ehrhardt <christian.ehrhardt@canonical.com> | 2019-07-04 10:48:05 +0200 |
commit | 8d53e9f3c6001dcb2865f6e894da5b54e1418f88 (patch) | |
tree | 63907f21c13636a987d43463c675d0727a04e327 /doc/guides/contributing/documentation.rst | |
parent | e2bea7436061ca2e7e14bfcfdc5870f2555c3965 (diff) |
New upstream version 18.11.2upstream-18.11-stable
Change-Id: I23eb4f9179abf1f9c659891f8fddb27ee68ad26b
Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
Diffstat (limited to 'doc/guides/contributing/documentation.rst')
-rw-r--r-- | doc/guides/contributing/documentation.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index c72280a2..408859e2 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -40,14 +40,14 @@ The main directories that contain files related to documentation are shown below |-- ... -The API documentation is built from `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ comments in the header files. +The API documentation is built from `Doxygen <http://www.doxygen.nl>`_ comments in the header files. These files are mainly in the ``lib/librte_*`` directories although some of the Poll Mode Drivers in ``drivers/net`` are also documented with Doxygen. The configuration files that are used to control the Doxygen output are in the ``doc/api`` directory. The user guides such as *The Programmers Guide* and the *FreeBSD* and *Linux Getting Started* Guides are generated -from RST markup text files using the `Sphinx <http://sphinx-doc.org/index.html>`_ Documentation Generator. +from RST markup text files using the `Sphinx <http://sphinx-doc.org>`_ Documentation Generator. These files are included in the ``doc/guides/`` directory. The output is controlled by the ``doc/guides/conf.py`` file. @@ -174,7 +174,8 @@ For full support with figure and table captioning the latest version of Sphinx c sudo pip install --upgrade sphinx sudo pip install --upgrade sphinx_rtd_theme -For further information on getting started with Sphinx see the `Sphinx Tutorial <http://sphinx-doc.org/tutorial.html>`_. +For further information on getting started with Sphinx see the +`Sphinx Getting Started <http://www.sphinx-doc.org/en/master/usage/quickstart.html>`_. .. Note:: @@ -596,7 +597,7 @@ Doxygen Guidelines The DPDK API is documented using Doxygen comment annotations in the header files. Doxygen is a very powerful tool, it is extremely configurable and with a little effort can be used to create expressive documents. -See the `Doxygen website <http://www.stack.nl/~dimitri/doxygen/>`_ for full details on how to use it. +See the `Doxygen website <http://www.doxygen.nl>`_ for full details on how to use it. The following are some guidelines for use of Doxygen in the DPDK API documentation: |