WIP

diff --git a/docs/en/rst/conf.py b/docs/en/rst/conf.py
index 2f0c722ffdc3d852ea421fdc53e5d672019ccf8b..40f9737e4851b4763a71718a148f27e92d728be3 100644 (file)
--- a/docs/en/rst/conf.py
+++ b/docs/en/rst/conf.py
@@ -25,7 +25,7 @@ needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.todo']
+extensions = ['sphinx.ext.todo', 'sphinx.ext.extlinks']
 
 if tags.has('enable_rst2pdf'):
   extensions.append('rst2pdf.pdfbuilder')
@@ -78,7 +78,7 @@ for line in open("../../../Bugzilla/Constants.pm"):
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['*.inc.rst']
+exclude_patterns = ['**.inc.rst']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -371,4 +371,7 @@ pdf_use_numbered_links = True
 # Background images fitting mode
 pdf_fit_background_mode = 'scale'
 
+# -- Options for Sphinx extensions -------------------------------------------
+
+# Temporary highlighting of TODO items
 todo_include_todos = True

diff --git a/docs/en/rst/index.rst b/docs/en/rst/index.rst
index 386cefc4ef7049b858e2c28350f0703e29519d17..37250c2b41913f8c5bde3e96752d7c4efc02b9a4 100644 (file)
--- a/docs/en/rst/index.rst
+++ b/docs/en/rst/index.rst
@@ -14,3 +14,5 @@ Bugzilla Documentation
    integrating/index
    administering/index
    using/index
+
+.. todolist::

diff --git a/docs/en/rst/installing/migrating.rst b/docs/en/rst/installing/migrating.rst
index 121f723dd406ef15fb79222511603726440c8b65..5b842dd3d1cba61067fb485133d03099e03b1404 100644 (file)
--- a/docs/en/rst/installing/migrating.rst
+++ b/docs/en/rst/installing/migrating.rst
@@ -1,4 +1,4 @@
-.. _migrating:
+.. _migrating-from-other-btses:
 
 Migrating From Other Bug-Tracking Systems
 #########################################

diff --git a/docs/en/rst/maintaining/sanity-check.rst b/docs/en/rst/maintaining/sanity-check.rst
index 87b8acd4059cad9cda2371b2b156c134eece46f9..4f8fb11c6902b34ea1d031b9cad545464f6f6b8a 100644 (file)
--- a/docs/en/rst/maintaining/sanity-check.rst
+++ b/docs/en/rst/maintaining/sanity-check.rst
@@ -4,28 +4,23 @@ Sanity Check
 ############
 
 Over time it is possible for the Bugzilla database to become corrupt
-or to have anomalies.
-This could happen through normal usage of Bugzilla, manual database
+or to have anomalies. This could happen through manual database
 administration outside of the Bugzilla user interface, or from some
-other unexpected event. Bugzilla includes a "Sanity Check" script that
+other unexpected event. Bugzilla includes a "Sanity Check" that
 can perform several basic database checks, and repair certain problems or
 inconsistencies.
 
-To run the "Sanity Check" script, log in as an Administrator and click the
-"Sanity Check" link in the admin page. Any problems that are found will be
-displayed in red letters. If the script is capable of fixing a problem,
-it will present a link to initiate the fix. If the script cannot
+To run a Sanity Check, log in as an Administrator and click the
+:guilabel:`Sanity Check` link in the admin page. Any problems that are found
+will be displayed in red letters. If the script is capable of fixing a
+problem, it will present a link to initiate the fix. If the script cannot
 fix the problem it will require manual database administration or recovery.
 
-The "Sanity Check" script can also be run from the command line via the perl
+Sanity Check can also be run from the command line via the perl
 script :file:`sanitycheck.pl`. The script can also be run as
-a :command:`cron` job. Results will be delivered by email.
+a :command:`cron` job. Results will be delivered by email to an address
+specified on the command line.
 
-The "Sanity Check" script should be run on a regular basis as a matter of
+Sanity Check should be run on a regular basis as a matter of
 best practice.
 
-.. warning:: The "Sanity Check" script is no substitute for a competent database
-   administrator. It is only designed to check and repair basic database
-   problems.
-
-

diff --git a/docs/en/rst/upgrading/migrating-from-1.rst.inc b/docs/en/rst/upgrading/migrating-from-1.inc.rst
similarity index 100%
rename from docs/en/rst/upgrading/migrating-from-1.rst.inc
rename to docs/en/rst/upgrading/migrating-from-1.inc.rst

diff --git a/docs/en/rst/upgrading/migrating-from-2.rst.inc b/docs/en/rst/upgrading/migrating-from-2.inc.rst
similarity index 100%
rename from docs/en/rst/upgrading/migrating-from-2.rst.inc
rename to docs/en/rst/upgrading/migrating-from-2.inc.rst

diff --git a/docs/en/rst/upgrading/migrating-from-a-tarball.rst b/docs/en/rst/upgrading/migrating-from-a-tarball.rst
index b84eacf65b9718c4e117b463fdae1d2f58418d00..9d075746d113ffa7a5c699447e6180c9fb4eabb4 100644 (file)
--- a/docs/en/rst/upgrading/migrating-from-a-tarball.rst
+++ b/docs/en/rst/upgrading/migrating-from-a-tarball.rst
@@ -22,4 +22,4 @@ in the top right corner of the front page but, if not, open the file
 :file:`Bugzilla/Constants.pm` in your Bugzilla directory and search for
 :code:`BUGZILLA_VERSION`.
 
-.. include:: migrating-from-2.rst.inc
+.. include:: migrating-from-2.inc.rst

diff --git a/docs/en/rst/upgrading/migrating-from-bzr.rst b/docs/en/rst/upgrading/migrating-from-bzr.rst
index ce693ad9050d18583a82e0d12cfa417c4f6c8650..da6809a0172b73237c74e3af8a3f1cde2090cbe7 100644 (file)
--- a/docs/en/rst/upgrading/migrating-from-bzr.rst
+++ b/docs/en/rst/upgrading/migrating-from-bzr.rst
@@ -7,5 +7,5 @@ Migrating from Bazaar
 .. |diffcommand|   replace:: :command:`bzr diff > patch.diff`
 .. |extstatusinfo| replace:: The command :command:`bzr status extensions/` should help you work out what you added, if anything.
 
-.. include:: migrating-from-1.rst.inc
-.. include:: migrating-from-2.rst.inc
+.. include:: migrating-from-1.inc.rst
+.. include:: migrating-from-2.inc.rst

diff --git a/docs/en/rst/upgrading/migrating-from-cvs.rst b/docs/en/rst/upgrading/migrating-from-cvs.rst
index 023b39856adbeb3d430acd5e1711c906560e110c..76f6253f2e231aa5d92c2196da2992a13708b438 100644 (file)
--- a/docs/en/rst/upgrading/migrating-from-cvs.rst
+++ b/docs/en/rst/upgrading/migrating-from-cvs.rst
@@ -7,7 +7,7 @@ Migrating from CVS
 .. |diffcommand|   replace:: :command:`cvs diff -puN > patch.diff`
 .. |extstatusinfo| replace:: The command :command:`cvs status extensions/` should help you work out what you added, if anything.
 
-.. include:: migrating-from-1.rst.inc
-.. include:: migrating-from-2.rst.inc
+.. include:: migrating-from-1.inc.rst
+.. include:: migrating-from-2.inc.rst
 
 

diff --git a/docs/en/rst/upgrading/upgrading-with-1.rst.inc b/docs/en/rst/upgrading/upgrading-with-1.inc.rst
similarity index 100%
rename from docs/en/rst/upgrading/upgrading-with-1.rst.inc
rename to docs/en/rst/upgrading/upgrading-with-1.inc.rst

diff --git a/docs/en/rst/upgrading/upgrading-with-2.rst.inc b/docs/en/rst/upgrading/upgrading-with-2.inc.rst
similarity index 100%
rename from docs/en/rst/upgrading/upgrading-with-2.rst.inc
rename to docs/en/rst/upgrading/upgrading-with-2.inc.rst

diff --git a/docs/en/rst/upgrading/upgrading-with-a-tarball.rst b/docs/en/rst/upgrading/upgrading-with-a-tarball.rst
index c38f28a2b0e368ae78351b78da7b2cdfeb18d45e..2bbfb31586225d889e7ff07483d882a111a7b216 100644 (file)
--- a/docs/en/rst/upgrading/upgrading-with-a-tarball.rst
+++ b/docs/en/rst/upgrading/upgrading-with-a-tarball.rst
@@ -10,7 +10,7 @@ installation using that.
 Without a source code management system to help you, the process may be
 trickier.
 
-.. include:: upgrading-with-1.rst.inc
+.. include:: upgrading-with-1.inc.rst
 
 As you are using a tarball and not an SCM, it's not at all easy to see if
 you've made local code customizations. You may have to use institutional
@@ -71,4 +71,4 @@ Now we swap the directories over. From the directory containing the
 
 :command:`cd bugzilla`
 
-.. include:: upgrading-with-2.rst.inc
+.. include:: upgrading-with-2.inc.rst

diff --git a/docs/en/rst/upgrading/upgrading-with-git.rst b/docs/en/rst/upgrading/upgrading-with-git.rst
index 1d9ba92f3dfc3f7ce73808698c1a2edc3a1eb161..523906f44475b4dd944ef61319c4e3941885dfae 100644 (file)
--- a/docs/en/rst/upgrading/upgrading-with-git.rst
+++ b/docs/en/rst/upgrading/upgrading-with-git.rst
@@ -9,7 +9,7 @@ intermediate steps. There is a script named :file:`checksetup.pl` included
 with Bugzilla that will automatically do all of the database migration
 for you.
 
-.. include:: upgrading-with-1.rst.inc
+.. include:: upgrading-with-1.inc.rst
 
 You can see if you have local code customizations using:
 
@@ -58,4 +58,4 @@ it fails, then you should implement the plan you came up with when you
 detected these customizations in the step above, before you started the
 upgrade.
 
-.. include:: upgrading-with-2.rst.inc
+.. include:: upgrading-with-2.inc.rst