On Thu, 2018-04-19 at 11:49 +0100, Ian Stokes wrote:
> Update dead url links for sphinx documentation to avoid
> make check-docs failing.
> 
> Cc: Stephen Finucane <[email protected]>
> Fixes: 26ea2d409 ("docs: Add writing guide")
> Fixes: 73c76b447 ("doc: Add info on building documentation")
> Signed-off-by: Ian Stokes <[email protected]>
> ---
>  Documentation/internals/contributing/documentation-style.rst | 3 ++-
>  Documentation/intro/install/documentation.rst                | 4 ++--
>  2 files changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/internals/contributing/documentation-style.rst 
> b/Documentation/internals/contributing/documentation-style.rst
> index 047f195..4e77db4 100644
> --- a/Documentation/internals/contributing/documentation-style.rst
> +++ b/Documentation/internals/contributing/documentation-style.rst
> @@ -441,4 +441,5 @@ Useful Links
>  - `Quick reStructuredText
>    <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`__
>  
> -- `Sphinx Documentation <http://sphinx.readthedocs.io/en/latest/rest.html>`__
> +- `Sphinx Documentation
> +  <http://rest-sphinx-memo.readthedocs.io/en/latest/ReST.html>`__

You're looking for this link:

  http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html

I'd rather we stuck to the authoritative resource on this.

> diff --git a/Documentation/intro/install/documentation.rst 
> b/Documentation/intro/install/documentation.rst
> index 0eeeab1..d7eb25d 100644
> --- a/Documentation/intro/install/documentation.rst
> +++ b/Documentation/intro/install/documentation.rst
> @@ -58,7 +58,7 @@ wish to install using ``pip``::
>      $ source .venv/bin/activate
>      $ pip install -r Documentation/requirements.txt
>  
> -__ http://www.sphinx-doc.org/install.html
> +__ http://www.sphinx-doc.org/en/master/usage/installation.html
>  
>  Configuring
>  -----------
> @@ -86,4 +86,4 @@ Makefile targets::
>  Once built, documentation is available in the ``/Documentation/_build`` 
> folder.
>  Open the root ``index.html`` to browse the documentation.
>  
> -__ http://www.sphinx-doc.org/config.html
> +__ http://www.sphinx-doc.org/en/master/config.html

Note that I'm planning to move this to 'usage/configuration.html'
shortly (I'm the one who's moving all those docs around). Not much we
can do until then though.

The one link aside, this LGTM.

Stephen
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to