Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-03-01 13:57:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1648959 - Done internal linking in docs in tools Directory DONTBUILD.r=championshuttler

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D81465
This commit is contained in:
chocos 2020-07-01 19:35:26 +00:00
parent 6492876c9d
commit 1e019373f9
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tools/moztreedocs/docs/jsdoc-support.rst
View File

@ -1,15 +1,14 @@
jsdoc support
=============
Here is a quick example, for the public AddonManager API:
https://firefox-source-docs.mozilla.org/toolkit/mozapps/extensions/addon-manager/AddonManager.html
Here is a quick example, for the public AddonManager :ref:`API <AddonManager Reference>`
To use it for your own code:
#. Check that JSDoc generates the output you expect (you may need to use a @class annotation on "object initializer"-style class definitions for instance)
#. Create an `.rst file`, which may contain explanatory text as well as the API docs. The minimum will look something like
https://firefox-source-docs.mozilla.org/_sources/toolkit/mozapps/extensions/addon-manager/AddonManager.rst.txt
`this <https://firefox-source-docs.mozilla.org/_sources/toolkit/mozapps/extensions/addon-manager/AddonManager.rst.txt>`__
#. Ensure your component is on the js_source_path here in the sphinx
config: https://hg.mozilla.org/mozilla-central/file/72ee4800d415/tools/docs/conf.py#l46

5
tools/tryselect/docs/selectors/chooser.rst
View File

@ -6,7 +6,7 @@ many to remember, making it easy to forget a set of tasks which should otherwise
This selector allows you to select tasks from a web interface that lists all the possible build and
test tasks and allows you to select them from a list. It is similar in concept to the old `try
syntax chooser`_ page, except that the values are dynamically generated using the `taskgraph`_ as an
syntax chooser`_ page, except that the values are dynamically generated using the :ref:`taskgraph<TaskCluster Task-Graph Generation>` as an
input. This ensures that it will never be out of date.
To use:
@ -25,9 +25,8 @@ You can run:
$ mach try chooser --full
To generate the interface using the full taskgraph instead. This will include tasks that don't run
To generate the interface using the full :ref:`taskgraph<TaskCluster Task-Graph Generation>` instead. This will include tasks that don't run
on mozilla-central.
.. _try syntax chooser: https://mozilla-releng.net/trychooser
.. _taskgraph: https://firefox-source-docs.mozilla.org/taskcluster/taskcluster/index.html