X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcontributing%2Fdocumentation.rst;h=27e4b13be1c47fc13854c869e34311e9ae492de9;hb=c2c0aa75cd0170cc243baf267622f7c3c5309fd5;hp=c72280a297c109d2d984d918cf43555e1d02aca7;hpb=63a71926e9f498bc121cec30de1ccae6970da612;p=dpdk.git diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index c72280a297..27e4b13be1 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -22,7 +22,6 @@ The main directories that contain files related to documentation are shown below |-- librte_acl |-- librte_cfgfile |-- librte_cmdline - |-- librte_compat |-- librte_eal | |-- ... ... @@ -40,14 +39,14 @@ The main directories that contain files related to documentation are shown below |-- ... -The API documentation is built from `Doxygen `_ comments in the header files. +The API documentation is built from `Doxygen `_ 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 `_ Documentation Generator. +from RST markup text files using the `Sphinx `_ Documentation Generator. These files are included in the ``doc/guides/`` directory. The output is controlled by the ``doc/guides/conf.py`` file. @@ -174,7 +173,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 `_. +For further information on getting started with Sphinx see the +`Sphinx Getting Started `_. .. Note:: @@ -199,10 +199,10 @@ The main required packages can be installed as follows: .. code-block:: console # Ubuntu/Debian. - sudo apt-get -y install texlive-latex-extra + sudo apt-get -y install texlive-latex-extra texlive-lang-greek # Red Hat/Fedora, selective install. - sudo dnf -y install texlive-collection-latexextra + sudo dnf -y install texlive-collection-latexextra texlive-greek-fontenc `Latexmk `_ is a perl script for running LaTeX for resolving cross references, @@ -596,7 +596,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 `_ for full details on how to use it. +See the `Doxygen website `_ for full details on how to use it. The following are some guidelines for use of Doxygen in the DPDK API documentation: