aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrédéric Buclin <LpSolit@gmail.com>2016-04-09 01:33:30 +0200
committerFrédéric Buclin <LpSolit@gmail.com>2016-04-09 01:33:30 +0200
commit9ad3cf5bfc73bd34b0ce309e45d9703691376748 (patch)
tree851c28bdc3e543f40139e17b709233293a034f58
parentBug 1246228 - Email addresses must not be encoded (diff)
downloadgentoo-bugzilla-9ad3cf5bfc73bd34b0ce309e45d9703691376748.zip
gentoo-bugzilla-9ad3cf5bfc73bd34b0ce309e45d9703691376748.tar.gz
gentoo-bugzilla-9ad3cf5bfc73bd34b0ce309e45d9703691376748.tar.bz2
Bug 1204957 - Locally compiled POD documentation is no longer accessible from docs/en/html/api/
r=dkl
-rw-r--r--docs/en/rst/api/index.rst3
-rw-r--r--docs/en/rst/conf.py11
-rw-r--r--docs/en/rst/integrating/apis.rst13
-rwxr-xr-xdocs/makedocs.pl10
4 files changed, 25 insertions, 12 deletions
diff --git a/docs/en/rst/api/index.rst b/docs/en/rst/api/index.rst
index 45055eb..840bcad 100644
--- a/docs/en/rst/api/index.rst
+++ b/docs/en/rst/api/index.rst
@@ -4,7 +4,8 @@ WebService API Reference
========================
This Bugzilla installation has the following WebService APIs available
-(as of the last time you compiled the documentation):
+(as of the last time you compiled the documentation). Documentation for
+the deprecated :ref:`XML-RPC and JSON-RPC APIs <api-list>` is also available.
.. toctree::
:glob:
diff --git a/docs/en/rst/conf.py b/docs/en/rst/conf.py
index 3330ca7..87109da 100644
--- a/docs/en/rst/conf.py
+++ b/docs/en/rst/conf.py
@@ -383,4 +383,13 @@ pdf_fit_background_mode = 'scale'
# Temporary highlighting of TODO items
todo_include_todos = False
-extlinks = {'bug': ('https://bugzilla.mozilla.org/show_bug.cgi?id=%s', 'bug ')}
+# The readthedocs.org website cannot access POD.
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if on_rtd:
+ base_api_url = 'https://www.bugzilla.org/docs/tip/en/html/api/'
+else:
+ base_api_url = '../integrating/api/'
+
+extlinks = {'bug': ('https://bugzilla.mozilla.org/show_bug.cgi?id=%s', 'bug '),
+ 'api': (base_api_url + '%s', '')}
diff --git a/docs/en/rst/integrating/apis.rst b/docs/en/rst/integrating/apis.rst
index 6067c12..54ee327 100644
--- a/docs/en/rst/integrating/apis.rst
+++ b/docs/en/rst/integrating/apis.rst
@@ -12,6 +12,13 @@ coming soon.
The APIs currently available are as follows:
+Core Module API
+===============
+
+Most of the core Bugzilla modules have extensive documentation inside the modules
+themselves. You can view the :api:`POD documentation <index.html>` to help with
+using the core modules in your extensions.
+
Ad-Hoc APIs
===========
@@ -23,8 +30,7 @@ to alternate data formats where they are available.
XML-RPC
=======
-Bugzilla has an `XML-RPC API
-<http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Server/XMLRPC.html>`_.
+Bugzilla has an :api:`XML-RPC API <Bugzilla/WebService/Server/XMLRPC.html>`.
This will receive no further updates and will be removed in a future version
of Bugzilla.
@@ -33,8 +39,7 @@ Endpoint: :file:`/xmlrpc.cgi`
JSON-RPC
========
-Bugzilla has a `JSON-RPC API
-<http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Server/JSONRPC.html>`_.
+Bugzilla has a :api:`JSON-RPC API <Bugzilla/WebService/Server/JSONRPC.html>`.
This will receive no further updates and will be removed in a future version
of Bugzilla.
diff --git a/docs/makedocs.pl b/docs/makedocs.pl
index 6f353dc..36ffc45 100755
--- a/docs/makedocs.pl
+++ b/docs/makedocs.pl
@@ -35,7 +35,7 @@ use lib qw(.. ../lib lib);
use Cwd;
use File::Copy::Recursive qw(rcopy);
use File::Find;
-use File::Path qw(rmtree);
+use File::Path qw(rmtree make_path);
use File::Which qw(which);
use Pod::Simple;
@@ -52,7 +52,6 @@ sub MakeDocs {
my ($name, $cmdline) = @_;
say "Creating $name documentation ..." if defined $name;
- say "make $cmdline\n";
system('make', $cmdline) == 0
or $error_found = 1;
print "\n";
@@ -83,12 +82,11 @@ END_HTML
$converter->contents_page_start($contents_start);
$converter->contents_page_end("</body></html>");
- $converter->add_css('./../../../style.css');
+ $converter->add_css('./../../../../style.css');
$converter->javascript_flurry(0);
$converter->css_flurry(0);
- mkdir("html");
- mkdir("html/api");
- $converter->batch_convert(['../../'], 'html/api/');
+ make_path('html/integrating/api');
+ $converter->batch_convert(['../../'], 'html/integrating/api');
print "\n";
}