Fix references to sphinx

This commit is contained in:
Pierre Labastie 2022-10-20 17:22:26 +02:00
parent 6e86a833af
commit 402910e9fb
10 changed files with 20 additions and 34 deletions

View File

@ -74,8 +74,7 @@
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<ulink url="https://www.sphinx-doc.org/en/stable/man/sphinx-build.html">Sphinx</ulink>
with <ulink url="https://pypi.python.org/pypi/sphinx_rtd_theme">sphinx_rtd_theme</ulink>
<xref linkend="sphinx_rtd_theme"/>
</para>
<para condition="html" role="usernotes">
@ -95,7 +94,7 @@
make</userinput></screen>
<para>
If you have the optional <application>Sphinx</application> package
If you have <xref linkend="sphinx_rtd_theme"/>
installed, build the documentation with:
</para>

View File

@ -81,7 +81,7 @@
<para role="optional">
<xref linkend="fop"/>,
<xref linkend="gnutls"/>, and
<ulink url="https://www.sphinx-doc.org/en/master/index.html">sphinx</ulink>
<xref linkend="sphinx"/>
</para>
<para condition="html" role="usernotes">

View File

@ -84,9 +84,7 @@
<bridgehead renderas="sect5">
Optional (Required to build the API and HTML Documentation)</bridgehead>
<para role="optional">
<xref linkend="docutils"/> and
<ulink url="https://www.sphinx-doc.org/en/master/">Sphinx</ulink> with
<ulink url="https://github.com/rtfd/sphinx_rtd_theme">sphinx_rtd_theme</ulink>
<xref linkend="sphinx_rtd_theme"/>
</para>
<para condition="html" role="usernotes">User Notes:

View File

@ -83,10 +83,8 @@
<xref linkend="cython"/>, <!-- required to python bindings -->
<xref linkend="jansson"/>, <!-- required to build the HPACK tools -->
<xref linkend="libevent"/>, <!--required to build the examples-->
<xref linkend="sphinx"/>, <!--required to build documentation-->
<!--<xref linkend="python2"/>,--> <!--required for the python bindings)-->
<!--- <phrase revision="systemd">
<xref linkend="setuptools"/>, <!- -(required for the python bindings- ->
</phrase> -->
<ulink url="http://cunit.sourceforge.net/">CUnit</ulink> (required for
the testsuite),
<!-- <ulink url="http://www.digip.org/jansson/">Jansson</ulink>, <!- -required
@ -95,15 +93,10 @@
<!--required for the example HTTP server-->
<ulink url="http://software.schmorp.de/pkg/libev.html">libev</ulink>,
<!--required to build the applications-->
<ulink url="https://mruby.org/">mruby</ulink>, <!--provides ruby support
in the sample HTTP server-->
<!-- <phrase revision="sysv">
<ulink url="https://pypi.python.org/pypi/setuptools/">Setuptools</ulink>,
</phrase> -->
<ulink url="https://tatsuhiro-t.github.io/spdylay/">Spdylay</ulink>, and
<ulink url="https://mruby.org/">mruby</ulink>, and
<!--provides ruby support in the sample HTTP server-->
<ulink url="https://tatsuhiro-t.github.io/spdylay/">Spdylay</ulink>,
<!--provide SPDY functionality-->
<ulink url="https://www.sphinx-doc.org/">Sphinx</ulink>. <!--required to build
documentation-->
</para>
<para condition="html" role="usernotes">

View File

@ -86,7 +86,7 @@
<para role="optional">
<xref linkend="libcap-pam"/>,
<xref linkend="libxml2"/>, and
<ulink url="https://www.sphinx-doc.org/en/master/">Sphinx</ulink>
<xref linkend="sphinx"/>
</para>
<para condition="html" role="usernotes">User Notes:

View File

@ -97,7 +97,7 @@
<para role="optional">
<xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests),
<xref linkend="reiserfs"/> (for tests), and
<ulink url="https://www.sphinx-doc.org/">Sphinx</ulink> (required to build documentation),
<xref linkend="sphinx"/> (required to build documentation),
</para>

View File

@ -107,10 +107,9 @@
<ulink url="https://gitlab.freedesktop.org/spice/libcacard">libcacard</ulink>
</para>
<bridgehead renderas="sect4">Optional dependencies for installing the documentation</bridgehead>
<bridgehead renderas="sect4">Optional (for building the documentation)</bridgehead>
<para role="optional">
<ulink url="https://www.sphinx-doc.org/en/master/index.html">sphinx</ulink> with the
<ulink url="https://pypi.org/project/sphinx-rtd-theme/">sphinx-rtd-theme</ulink> theme
<xref linkend="sphinx_rtd_theme"/>
</para>
<note>

View File

@ -111,6 +111,7 @@
<xref linkend="mitkrb"/>,
<xref linkend="pcre2"/>,
<xref linkend="ruby"/>,
<xref linkend="sphinx"/>,
<xref linkend="unixodbc"/>,
<xref linkend="valgrind"/>,
<ulink url="https://groonga.org/">Groonga</ulink>,
@ -121,8 +122,7 @@
<ulink url="https://msgpack.org/">MessagePack</ulink>,
<ulink url="https://www.mruby.org/">mruby</ulink>,
<ulink url="https://mariadb.com/kb/en/myrocks/">MyRocks</ulink>,
<ulink url="https://github.com/google/snappy">Snappy</ulink>,
<ulink url="https://sphinxsearch.com/downloads/">Sphinx</ulink>, and
<ulink url="https://github.com/google/snappy">Snappy</ulink>, and
<!--<ulink url="https://mariadb.com/kb/en/mariadb/tokudb/">TokuDB</ulink>, and-->
<ulink url="https://zeromq.org/">ZeroMQ</ulink>
</para>

View File

@ -100,10 +100,10 @@
<xref linkend="libxml2"/>,
<xref linkend="lmdb"/>,
<xref linkend="mitkrb"/>,
<xref linkend="sphinx"/> (required to build documentation),
<ulink url="https://cmocka.org/">cmocka</ulink>,
<ulink url="https://github.com/cjheath/geoip">geoip</ulink>,
<ulink url="https://docs.pytest.org/en/stable/">pytest</ulink>,
<ulink url="https://pypi.python.org/pypi/Sphinx">Sphinx</ulink> (required to build documentation), and
<ulink url="https://docs.pytest.org/en/stable/">pytest</ulink>, and
<ulink url="&w3m-url;">w3m</ulink>
</para>
@ -577,10 +577,7 @@ dig www.&lfs-domainname;</userinput></screen>
The ARM documentation (do not confuse with the processor architecture)
is included in the source package. The documentation is in .rst
format which means, it can be converted in human readable formats
if <ulink url="https://www.sphinx-doc.org/">Sphinx</ulink> is
installed. As time of writing, sphinx is not included in
the BLFS book and therefore, the instructions above do not
install the docs.
if <xref linkend="sphinx"/> is installed.
</para>
<para>
@ -588,7 +585,7 @@ dig www.&lfs-domainname;</userinput></screen>
to operate in a real live scenario, it is <emphasis>highly</emphasis>
recommended to consult the ARM documentation. ISC provides an
updated set of excellent documentation along with every release
so it can be easily be viewed and/or downloaded - so there is
so it can be easily viewed and/or downloaded &ndash; so there is
no excuse to not read the docs. The formats ISC provides are PDF,
epub and html at <ulink url="https://downloads.isc.org/isc/bind9/&bind-version;/doc/arm/"/>.
</para>

View File

@ -88,8 +88,8 @@
<xref linkend="gtk3"/> (to build the GUI event viewer),
<xref linkend="libunwind"/> (required for tests),
<xref linkend="libwacom"/>, and
<ulink url="https://www.sphinx-doc.org/">Sphinx</ulink> (required to build documentation),
<ulink url="https://pypi.org/project/pyparsing/">PyParsing</ulink> (for one non-root test)
<xref linkend="sphinx"/> (required to build documentation),
<xref linkend="pyparsing"/> (for one non-root test)
</para>
<para condition="html" role="usernotes">