* [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites
@ 2019-04-03 11:04 Dekel Peled
2019-04-03 11:04 ` Dekel Peled
2019-04-05 7:57 ` Thomas Monjalon
0 siblings, 2 replies; 4+ messages in thread
From: Dekel Peled @ 2019-04-03 11:04 UTC (permalink / raw)
To: john.mcnamara, marko.kovacevic; +Cc: dev, orika, stable
Update broken links, replace with valid links.
Fixes: 7798f17a0d62 ("doc: add documentation guidelines")
Cc: stable@dpdk.org
Signed-off-by: Dekel Peled <dekelp@mellanox.com>
---
doc/guides/contributing/documentation.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index baf0921..7a2f81a 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -39,14 +39,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.
@@ -173,7 +173,7 @@ 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::
@@ -595,7 +595,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:
--
1.8.3.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites
2019-04-03 11:04 [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites Dekel Peled
@ 2019-04-03 11:04 ` Dekel Peled
2019-04-05 7:57 ` Thomas Monjalon
1 sibling, 0 replies; 4+ messages in thread
From: Dekel Peled @ 2019-04-03 11:04 UTC (permalink / raw)
To: john.mcnamara, marko.kovacevic; +Cc: dev, orika, stable
Update broken links, replace with valid links.
Fixes: 7798f17a0d62 ("doc: add documentation guidelines")
Cc: stable@dpdk.org
Signed-off-by: Dekel Peled <dekelp@mellanox.com>
---
doc/guides/contributing/documentation.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index baf0921..7a2f81a 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -39,14 +39,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.
@@ -173,7 +173,7 @@ 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::
@@ -595,7 +595,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:
--
1.8.3.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites
2019-04-03 11:04 [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites Dekel Peled
2019-04-03 11:04 ` Dekel Peled
@ 2019-04-05 7:57 ` Thomas Monjalon
2019-04-05 7:57 ` Thomas Monjalon
1 sibling, 1 reply; 4+ messages in thread
From: Thomas Monjalon @ 2019-04-05 7:57 UTC (permalink / raw)
To: Dekel Peled; +Cc: dev, john.mcnamara, marko.kovacevic, orika, stable
03/04/2019 13:04, Dekel Peled:
> Update broken links, replace with valid links.
>
> Fixes: 7798f17a0d62 ("doc: add documentation guidelines")
> Cc: stable@dpdk.org
>
> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Applied, thanks
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites
2019-04-05 7:57 ` Thomas Monjalon
@ 2019-04-05 7:57 ` Thomas Monjalon
0 siblings, 0 replies; 4+ messages in thread
From: Thomas Monjalon @ 2019-04-05 7:57 UTC (permalink / raw)
To: Dekel Peled; +Cc: dev, john.mcnamara, marko.kovacevic, orika, stable
03/04/2019 13:04, Dekel Peled:
> Update broken links, replace with valid links.
>
> Fixes: 7798f17a0d62 ("doc: add documentation guidelines")
> Cc: stable@dpdk.org
>
> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Applied, thanks
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2019-04-05 7:57 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-04-03 11:04 [dpdk-dev] [PATCH] doc: fix links to doxygen and sphinx sites Dekel Peled
2019-04-03 11:04 ` Dekel Peled
2019-04-05 7:57 ` Thomas Monjalon
2019-04-05 7:57 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).