]> git.ipfire.org Git - thirdparty/bugzilla.git/commitdiff
Bug 1260027: Document how to compile the documentation on Windows
authorFrédéric Buclin <LpSolit@gmail.com>
Fri, 1 Apr 2016 21:33:04 +0000 (23:33 +0200)
committerFrédéric Buclin <LpSolit@gmail.com>
Fri, 1 Apr 2016 21:33:04 +0000 (23:33 +0200)
r=gerv

docs/en/rst/installing/optional-post-install-config.rst
docs/en/rst/installing/windows.rst

index 91d5245d1f4193bafa9bf049fdaa7b874a6c604f..accc48888d7f180683441cb7e2c2c1f093a5f741 100644 (file)
@@ -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`
index ef1a1f6f49167ae7ff18547dff82a4b4b4b41dbd..adc1728c6964de6b8e4c43e761a7e6678858f515 100644 (file)
@@ -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