NO BUG - Marionette docs are generated with Sphinx. r=me
authorAndreas Tolfsen <ato@sny.no>
Tue, 24 Apr 2018 08:21:22 +0100
changeset 468837 1e43ad3c9528aaa14b386a945d33a015ef2ce7e0
parent 468836 0a370d5db96338216b41b36d02d4ca7f7f0cc7be
child 468838 f4ca8a10f581552132c22ab4ddee242c523b9710
push id9165
push userasasaki@mozilla.com
push dateThu, 26 Apr 2018 21:04:54 +0000
treeherdermozilla-beta@064c3804de2e [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersme
milestone61.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
NO BUG - Marionette docs are generated with Sphinx. r=me MozReview-Commit-ID: 7PnX4xqROm2
testing/marionette/doc/CodeStyle.md
--- a/testing/marionette/doc/CodeStyle.md
+++ b/testing/marionette/doc/CodeStyle.md
@@ -1,10 +1,10 @@
-Style guide for source code
-===========================
+Style guide
+===========
 
 Like other projects, we also have some guidelines to keep to the code.
 For the overall Marionette project, a few rough rules are:
 
   * Make your code readable and sensible, and don’t try to be
     clever.  Prefer simple and easy solutions over more convoluted
     and foreign syntax.
 
@@ -205,32 +205,24 @@ which happens to be the default on BSD a
 We endeavour to document all _public APIs_ of the Marionette component.
 These include public functions—or command implementations—on
 the `GeckoDriver` class, as well as all exported symbols from
 other modules.  Documentation for non-exported symbols is not required.
 
 The API documentation can be regenerated to [testing/marionette/doc/api]
 so:
 
-	% ./mach marionette doc
+The API documentation uses [jsdoc] and is generated to <https://firefox-source-docs.mozilla.org/testing/marionette/marionette/internals> on Taskcluster.  You may also build the documentation locally:
 
-You can also serve the documentation in an HTTP server if you work
-remotely on another terminal:
-
-	% ./mach marionette doc --http 0.0.0.0:6060
-	serving at 0.0.0.0:6060
+	% ./mach doc
 
-Normally there is no need to regenerate the API documentation after you
-make a change.  ato’s [mnapigen] script runs regularly in a cron job.
-
-[Mozilla eslint rules]: ../../../.eslintrc.js
-[mnapigen]: https://git.sny.no/rc/tree/bin/mnapigen
-[testing/geckodriver/doc]: ../../geckodriver/doc
-[testing/marionette/doc/api]: api/
-[testing/marionette/doc]: .
+[Mozilla eslint rules]: https://searchfox.org/mozilla-central/source/.eslintrc.js
+[testing/geckodriver/doc]: https://searchfox.org/mozilla-central/source/testing/geckodriver/doc
+[testing/marionette/doc]: https://searchfox.org/mozilla-central/source/testing/marionette/doc
+[jsdoc]: http://usejsdoc.org/
 
 
 Linting
 -------
 
 Marionette consists mostly of JavaScript (server) and Python (client,
 harness, test runner) code.  We lint our code with [mozlint],
 which harmonises the output from [eslint] and [flake8].