Commit e82a8134 authored by Gervase Markham's avatar Gervase Markham

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

parent 73e52e85
...@@ -83,7 +83,7 @@ libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl ...@@ -83,7 +83,7 @@ libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl
libtest-taint-perl libauthen-radius-perl libfile-slurp-perl libtest-taint-perl libauthen-radius-perl libfile-slurp-perl
libencode-detect-perl libmodule-build-perl libnet-ldap-perl libencode-detect-perl libmodule-build-perl libnet-ldap-perl
libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-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 If you plan to use SQlite as your database, you will need to also install
the appropriate packages for that. the appropriate packages for that.
......
...@@ -131,3 +131,24 @@ Download and install Graphviz from ...@@ -131,3 +131,24 @@ Download and install Graphviz from
the complete path to :file:`dot.exe` in the :param:`webdotbase` parameter, the complete path to :file:`dot.exe` in the :param:`webdotbase` parameter,
using forward slashes as path separators. E.g. using forward slashes as path separators. E.g.
:paramval:`C:/Program Files/ATT/Graphviz/bin/dot.exe`. :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.
...@@ -50,7 +50,7 @@ Install Prerequisites ...@@ -50,7 +50,7 @@ Install Prerequisites
:command:`apt-get install git nano` :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 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 the next steps (up to step 7) in another terminal while you wait for the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment