From 70973ef7f462962c556b6c2a2dc77ff391684992 Mon Sep 17 00:00:00 2001
From: Gervase Markham <gerv@gerv.net>
Date: Wed, 7 Jan 2015 16:01:55 +0000
Subject: Bug 1107549 - split extension docs into User and Admin docs. r=dkl,
 a=glob.

---
 docs/en/rst/administering/extensions.rst |  4 ++--
 docs/en/rst/api/index.rst                |  4 ++--
 docs/en/rst/using/extensions.rst         | 18 ++++++++++++++++
 docs/en/rst/using/index.rst              |  1 +
 docs/makedocs.pl                         | 36 +++++++++++++-------------------
 5 files changed, 37 insertions(+), 26 deletions(-)
 create mode 100644 docs/en/rst/using/extensions.rst

(limited to 'docs')

diff --git a/docs/en/rst/administering/extensions.rst b/docs/en/rst/administering/extensions.rst
index 0d5a216af..2c54b8463 100644
--- a/docs/en/rst/administering/extensions.rst
+++ b/docs/en/rst/administering/extensions.rst
@@ -1,4 +1,4 @@
-.. _installed-extensions:
+.. _installed-extensions-admin:
 
 Installed Extensions
 ====================
@@ -15,4 +15,4 @@ last time you compiled the documentation):
    :maxdepth: 1
    :glob:
    
-   ../extensions/*
+   ../extensions/*/index-admin
diff --git a/docs/en/rst/api/index.rst b/docs/en/rst/api/index.rst
index 55c997a68..45055eba1 100644
--- a/docs/en/rst/api/index.rst
+++ b/docs/en/rst/api/index.rst
@@ -9,5 +9,5 @@ This Bugzilla installation has the following WebService APIs available
 .. toctree::
    :glob:
 
-   core/v*/index*
-   extensions/*/v*/index*
+   core/v*/index
+   ../extensions/*/api/v*/index
diff --git a/docs/en/rst/using/extensions.rst b/docs/en/rst/using/extensions.rst
new file mode 100644
index 000000000..28bae5be5
--- /dev/null
+++ b/docs/en/rst/using/extensions.rst
@@ -0,0 +1,18 @@
+.. _installed-extensions-user:
+
+Installed Extensions
+====================
+
+Bugzilla can be enhanced using extensions (see :ref:`extensions`). If an
+extension comes with documentation in the appropriate format, and you build
+your own copy of the Bugzilla documentation using :file:`makedocs.pl`, then
+the documentation for your installed extensions will show up here.
+
+Your Bugzilla installation has the following extensions available (as of the
+last time you compiled the documentation):
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   ../extensions/*/index-user
diff --git a/docs/en/rst/using/index.rst b/docs/en/rst/using/index.rst
index f336b3729..73aa707c3 100644
--- a/docs/en/rst/using/index.rst
+++ b/docs/en/rst/using/index.rst
@@ -15,4 +15,5 @@ User Guide
    reports-and-charts
    tips
    preferences
+   extensions
 
diff --git a/docs/makedocs.pl b/docs/makedocs.pl
index 811ef8bc5..31ad0c610 100755
--- a/docs/makedocs.pl
+++ b/docs/makedocs.pl
@@ -12,11 +12,13 @@
 #
 # 1) Sphinx documentation builder (python-sphinx package on Debian/Ubuntu)
 #
-# 2) pdflatex, which means the following Debian/Ubuntu packages:
-#    * texlive-latex-base
-#    * texlive-latex-recommended
-#    * texlive-latex-extra
-#    * texlive-fonts-recommended
+# 2a) rst2pdf
+# or
+# 2b) pdflatex, which means the following Debian/Ubuntu packages:
+#     * texlive-latex-base
+#     * texlive-latex-recommended
+#     * texlive-latex-extra
+#     * texlive-fonts-recommended
 #
 # All these TeX packages together are close to a gig :-| But after you've
 # installed them, you can remove texlive-latex-extra-doc to save 400MB.
@@ -143,25 +145,15 @@ foreach my $lang (@langs) {
 
     # Collect up local extension documentation into the extensions/ dir.
     # Clear out old extensions docs
-    rmtree('rst/extensions', 0, 1);
-    mkdir('rst/extensions');
-    rmtree('rst/api/extensions', 0, 1);
-    mkdir('rst/api/extensions');
+    # For the life of me, I cannot get rmtree() to work here. It just returns
+    # silently without deleting anything - no errors.
+    system("rm -rf $lang/rst/extensions/*");
 
     foreach my $ext_name (keys %extensions) {
-        foreach my $path (glob($extensions{$ext_name} . "/*")) {
-            my ($file, $dir) = fileparse($path);
-            if ($file eq 'api') {
-                my $dst = "$docparent/$lang/rst/api/extensions/$ext_name";
-                mkdir($dst) unless -d $dst;
-                rcopy("$path/*", $dst);
-            }
-            else {
-                my $dst = "$docparent/$lang/rst/extensions/$ext_name";
-                mkdir($dst) unless -d $dst;
-                rcopy($path, "$dst/$file");
-            }
-        }
+        my $src = $extensions{$ext_name} . "/*";
+        my $dst = "$docparent/$lang/rst/extensions/$ext_name";
+        mkdir($dst) unless -d $dst;
+        rcopy($src, $dst);
     }
 
     chdir "$docparent/$lang";
-- 
cgit v1.2.3-24-g4f1b