diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/rst/installing/optional-post-install-config.rst | 47 | ||||
| -rw-r--r-- | docs/en/rst/installing/windows.rst | 9 |
2 files changed, 40 insertions, 16 deletions
diff --git a/docs/en/rst/installing/optional-post-install-config.rst b/docs/en/rst/installing/optional-post-install-config.rst index 91d5245d1..76fe0c830 100644 --- a/docs/en/rst/installing/optional-post-install-config.rst +++ b/docs/en/rst/installing/optional-post-install-config.rst @@ -115,22 +115,22 @@ 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 ----- Put the complete path to the :file:`dot` command (from the ``graphviz`` -package) in the :param:`webdotbase` parameter. E.g. :paramval:`/usr/bin/dot`. +package) in the :param:`webdotbase` variable in the :file:`localconfig` file. +E.g. :paramval:`/usr/bin/dot`. 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`. +the complete path to :file:`dot.exe` in the :param:`webdotbase` variable in the +:file:`localconfig` file. E.g. :paramval:`C:\\Program Files (x86)\\Graphviz2.38\\bin\\dot.exe`. Documentation ============= @@ -139,16 +139,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 3aad5cb94..c4f8a2848 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 @@ -126,18 +127,20 @@ installed: * Cache-Memcached * Text-Markdown * File-Copy-Recursive -* GraphViz -If you are using Strawberry Perl, you should use the :file:`install-module.pl` +If you are using Strawberry Perl, you should use the :file:`cpanm` script to install modules, which is the same script used for Linux. Some of the required modules are already installed by default. The remaining ones can be installed using the command: -:command:`perl install-module.pl <modulename>` +:command:`cpanm -l local <modulename>` The list of modules to install will be displayed by :file:`checksetup.pl`; see below. +.. warning:: In master, :file:`checksetup.pl` no longer lists these modules. + This will be fixed in :bug:`1251100`. + .. _windows-config-webserver: Web Server |