Bug 1112643 - Document how to compile documentation. r,a=glob.

diff --git a/docs/en/rst/installing/linux.rst b/docs/en/rst/installing/linux.rst
index b17998b53d8b87319c69e08f0efba6fdf1c86b7d..1ab87821e94ea93442c71a212790ff73bc01384a 100644 (file)
--- a/docs/en/rst/installing/linux.rst
+++ b/docs/en/rst/installing/linux.rst
@@ -83,7 +83,7 @@ libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl
 libtest-taint-perl libauthen-radius-perl libfile-slurp-perl
 libencode-detect-perl libmodule-build-perl libnet-ldap-perl
 libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-perl
-libhtml-formattext-withlinks-perl libgd-dev lynx-cur graphviz`
+libhtml-formattext-withlinks-perl libgd-dev lynx-cur graphviz python-sphinx`
 
 If you plan to use SQlite as your database, you will need to also install
 the appropriate packages for that.

diff --git a/docs/en/rst/installing/optional-post-install-config.rst b/docs/en/rst/installing/optional-post-install-config.rst
index f79918d2ac40eeae64a23af226f26a49ce2d8ced..91d5245d1f4193bafa9bf049fdaa7b874a6c604f 100644 (file)
--- a/docs/en/rst/installing/optional-post-install-config.rst
+++ b/docs/en/rst/installing/optional-post-install-config.rst
@@ -131,3 +131,24 @@ Download and install Graphviz from
 the complete path to :file:`dot.exe` in the :param:`webdotbase` parameter,
 using forward slashes as path separators. E.g.
 :paramval:`C:/Program Files/ATT/Graphviz/bin/dot.exe`.
+
+Documentation
+=============
+
+Bugzilla has extensive documentation and help, written in
+`reStructured Text <http://sphinx-doc.org/rest.html>`_
+format. A generic compiled copy exists on
+`bugzilla.readthedocs.org <https://bugzilla.readthedocs.org/>`_, and
+:guilabel:`Help` links point to it by default. If you want to build and use a
+local copy of the documentation, perhaps because you have added Bugzilla
+extensions which come with documentation, or because your users don't have
+Internet access from their machines, then:
+
+* Install `Sphinx <http://sphinx-doc.org/>`_
+  (:file:`python-sphinx` package on Debian/Ubuntu)
+
+Then run :command:`docs/makedocs.pl` in your Bugzilla directory.
+
+Bugzilla will automatically detect that you've compiled the documentation
+and link to it in preference to the copy on the Internet. Don't forget to
+recompile it when you upgrade Bugzilla or install new extensions.

diff --git a/docs/en/rst/installing/quick-start.rst b/docs/en/rst/installing/quick-start.rst
index 0d34d12edb42aad120345a4fffe7d3d7e655727c..1fd7f2fa5bbf84d5d25b9602ee95cdeb5a1faa2c 100644 (file)
--- a/docs/en/rst/installing/quick-start.rst
+++ b/docs/en/rst/installing/quick-start.rst
@@ -50,7 +50,7 @@ Install Prerequisites
 
 :command:`apt-get install git nano`
 
-:command:`apt-get install apache2 mysql-server libappconfig-perl libdate-calc-perl libtemplate-perl libmime-perl build-essential libdatetime-timezone-perl libdatetime-perl libemail-sender-perl libemail-mime-perl libemail-mime-modifier-perl libdbi-perl libdbd-mysql-perl libcgi-pm-perl libmath-random-isaac-perl libmath-random-isaac-xs-perl apache2-mpm-prefork libapache2-mod-perl2 libapache2-mod-perl2-dev libchart-perl libxml-perl libxml-twig-perl perlmagick libgd-graph-perl libtemplate-plugin-gd-perl libsoap-lite-perl libhtml-scrubber-perl libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl libtest-taint-perl libauthen-radius-perl libfile-slurp-perl libencode-detect-perl libmodule-build-perl libnet-ldap-perl libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-perl libhtml-formattext-withlinks-perl libgd-dev lynx-cur`
+:command:`apt-get install apache2 mysql-server libappconfig-perl libdate-calc-perl libtemplate-perl libmime-perl build-essential libdatetime-timezone-perl libdatetime-perl libemail-sender-perl libemail-mime-perl libemail-mime-modifier-perl libdbi-perl libdbd-mysql-perl libcgi-pm-perl libmath-random-isaac-perl libmath-random-isaac-xs-perl apache2-mpm-prefork libapache2-mod-perl2 libapache2-mod-perl2-dev libchart-perl libxml-perl libxml-twig-perl perlmagick libgd-graph-perl libtemplate-plugin-gd-perl libsoap-lite-perl libhtml-scrubber-perl libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl libtest-taint-perl libauthen-radius-perl libfile-slurp-perl libencode-detect-perl libmodule-build-perl libnet-ldap-perl libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-perl libhtml-formattext-withlinks-perl libgd-dev lynx-cur python-sphinx`
 
 This will take a little while. It's split into two commands so you can do
 the next steps (up to step 7) in another terminal while you wait for the