Bug 1557319 - Create a top-level toolkit index for the toolkit documentation. r=ahal
authorMark Banner <standard8@mozilla.com>
Fri, 07 Jun 2019 07:26:42 +0000
changeset 477774 f0eedecf8f2d2864ce03867e867b2164cb6753ef
parent 477773 a8e20517d31154bcbc582ceeeeef8f4be0b3f554
child 477775 63ea9ea7e7415da09c138a9f6457b7f6474f77ce
push id36123
push userdvarga@mozilla.com
push dateFri, 07 Jun 2019 16:17:54 +0000
treeherdermozilla-central@0c2b0dd884cc [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersahal
bugs1557319
milestone69.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1557319 - Create a top-level toolkit index for the toolkit documentation. r=ahal Differential Revision: https://phabricator.services.mozilla.com/D33962
toolkit/docs/index.rst
toolkit/modules/docs/index.rst
toolkit/moz.build
new file mode 100644
--- /dev/null
+++ b/toolkit/docs/index.rst
@@ -0,0 +1,20 @@
+=======
+Toolkit
+=======
+
+This is the nascent documentation of the Toolkit code that is shared across Firefox, Firefox for Android and other applications.
+
+.. toctree::
+   :maxdepth: 1
+
+   mozapps/extensions/addon-manager/index
+   components/crashes/crash-manager/index
+   crashreporter/crashreporter/index
+   components/featuregates/featuregates/index
+   components/normandy/normandy/index
+   modules/subprocess/toolkit_modules/subprocess/index
+   components/telemetry/telemetry/index
+   modules/toolkit_modules/index
+   content/toolkit_widgets/index
+   components/url-classifier/url-classifier/index
+   components/extensions/webextensions/index
--- a/toolkit/modules/docs/index.rst
+++ b/toolkit/modules/docs/index.rst
@@ -1,10 +1,10 @@
 ===============
-Toolkit modules
+Toolkit Modules
 ===============
 
 The ``/toolkit/modules`` directory contains a number of self-contained toolkit modules considered small enough that they do not deserve individual directories.
 
 .. toctree::
   :maxdepth: 1
 
   AsyncShutdown
--- a/toolkit/moz.build
+++ b/toolkit/moz.build
@@ -1,14 +1,16 @@
 # -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*-
 # vim: set filetype=python:
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
+SPHINX_TREES['/toolkit'] = 'docs'
+
 DIRS += [
     'actors',
     'components',
     'content',
     'crashreporter',
     'forgetaboutsite',
     'locales',
     'modules',
@@ -47,16 +49,19 @@ elif CONFIG['MOZ_WIDGET_TOOLKIT'] == 'wi
             'system/windowsDHCPClient']
 elif CONFIG['MOZ_WIDGET_TOOLKIT'] == 'android':
     DIRS += ['system/androidproxy']
 
 TEST_HARNESS_FILES.testing.mochitest.browser.toolkit.crashreporter.test.browser += [
     'crashreporter/test/browser/crashreport.sjs',
 ]
 
+with Files('docs/**'):
+    BUG_COMPONENT = ('Toolkit', 'General')
+
 with Files('moz.*'):
     BUG_COMPONENT = ('Firefox Build System', 'General')
 
 with Files('toolkit.mozbuild'):
     BUG_COMPONENT = ('Firefox Build System', 'General')
 
 with Files('nss.configure'):
     BUG_COMPONENT = ('Firefox Build System', 'General')