aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrédéric Buclin <LpSolit@gmail.com>2016-04-01 23:33:04 +0200
committerFrédéric Buclin <LpSolit@gmail.com>2016-04-01 23:33:04 +0200
commit97a24182d168363860dc153771e0b93f9520036d (patch)
tree139ca8f3d2a059630bb6b4e32d9699eb27f1dbbb
parentBug 1200010: The Quick Start doc should stop assuming Bugzilla is your single... (diff)
downloadgentoo-bugzilla-97a24182d168363860dc153771e0b93f9520036d.zip
gentoo-bugzilla-97a24182d168363860dc153771e0b93f9520036d.tar.gz
gentoo-bugzilla-97a24182d168363860dc153771e0b93f9520036d.tar.bz2
Bug 1260027: Document how to compile the documentation on Windows
r=gerv
-rw-r--r--docs/en/rst/installing/optional-post-install-config.rst42
-rw-r--r--docs/en/rst/installing/windows.rst2
2 files changed, 32 insertions, 12 deletions
diff --git a/docs/en/rst/installing/optional-post-install-config.rst b/docs/en/rst/installing/optional-post-install-config.rst
index 91d5245..accc488 100644
--- a/docs/en/rst/installing/optional-post-install-config.rst
+++ b/docs/en/rst/installing/optional-post-install-config.rst
@@ -115,7 +115,7 @@ Dependency Graphs
=================
Bugzilla can draw graphs of the dependencies (depends on/blocks relationships)
-between bugs, if you install a package called :file:`dot`.
+between bugs, if you install a package called :file:`graphviz`.
Linux
-----
@@ -129,8 +129,7 @@ Windows
Download and install Graphviz from
`the Graphviz website <http://www.graphviz.org/Download_windows.php>`_. Put
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`.
+e.g. :paramval:`C:\\Program Files (x86)\\Graphviz2.38\\bin\\dot.exe`.
Documentation
=============
@@ -139,16 +138,37 @@ 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
+:guilabel:`Help` links point to it by default. You can also build and use
+a local copy of the documentation, for instance 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.
+Internet access from their machines.
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.
+
+Linux
+-----
+
+* Install `Sphinx <http://sphinx-doc.org/>`_. Most Linux distros have it in
+ a package named :file:`python-sphinx`.
+
+* Then go to your Bugzilla directory and run:
+
+ :command:`docs/makedocs.pl`
+
+Windows
+-------
+
+* Download and install `Python <https://www.python.org/downloads/>`_.
+ Both Python 2.7 and 3.x will work. Adding :file:`python` to the :param:`PATH`
+ environment variable, as suggested by the Python installer, will make your
+ life easier.
+
+* Install `Sphinx <http://sphinx-doc.org/>`_. Run :command:`cmd.exe` and type:
+
+ :command:`pip install sphinx`
+
+* Then go to your :file:`C:\\bugzilla\\docs` directory and run:
+
+ :command:`makedocs.pl`
diff --git a/docs/en/rst/installing/windows.rst b/docs/en/rst/installing/windows.rst
index ef1a1f6..adc1728 100644
--- a/docs/en/rst/installing/windows.rst
+++ b/docs/en/rst/installing/windows.rst
@@ -89,6 +89,7 @@ Install the following mandatory modules with:
* JSON-XS
* Win32
* Win32-API
+* DateTime-TimeZone-Local-Win32
The following modules enable various optional Bugzilla features; try and
install them, but don't worry too much to begin with if you can't get them
@@ -125,7 +126,6 @@ installed:
* IO-stringy
* Cache-Memcached
* File-Copy-Recursive
-* GraphViz
If you are using Strawberry Perl, you should use the :file:`install-module.pl`
script to install modules, which is the same script used for Linux. Some of