Bug 1531068 - [marionette] Remove remaining links to readthedocs from client documentation. r=me
authorHenrik Skupin <mail@hskupin.info>
Mon, 04 Mar 2019 14:31:54 +0100
changeset 462302 559e8b22fdc5812619eec44c0ed96f2631f172b0
parent 462253 846b0c8b048e9b83f0f3b184a7bf2bc8001e6bf6
child 462303 a4bdd668c63799c218c76873591ddc72598f1fc1
push id35647
push useraciure@mozilla.com
push dateTue, 05 Mar 2019 04:21:25 +0000
treeherdermozilla-central@c59f0f40e0f6 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersme
bugs1531068
milestone67.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 1531068 - [marionette] Remove remaining links to readthedocs from client documentation. r=me DONTBUILD
testing/marionette/client/setup.py
testing/marionette/doc/PythonTests.md
testing/marionette/puppeteer/firefox/docs/index.rst
testing/web-platform/tests/docs/_writing-tests/testdriver-tutorial.md
--- a/testing/marionette/client/setup.py
+++ b/testing/marionette/client/setup.py
@@ -19,17 +19,17 @@ def read(*parts):
 def get_version():
     return re.findall("__version__ = '([\d\.]+)'",
                       read('marionette_driver', '__init__.py'), re.M)[0]
 
 
 setup(name='marionette_driver',
       version=get_version(),
       description="Marionette Driver",
-      long_description='See http://marionette-client.readthedocs.org/en/latest/',
+      long_description='See https://firefox-source-docs.mozilla.org/python/marionette_driver.html',
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       classifiers=[
           'Development Status :: 5 - Production/Stable',
           'Intended Audience :: Developers',
           'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
           'Operating System :: MacOS :: MacOS X',
           'Operating System :: Microsoft :: Windows',
           'Operating System :: POSIX',
--- a/testing/marionette/doc/PythonTests.md
+++ b/testing/marionette/doc/PythonTests.md
@@ -55,17 +55,17 @@ Assertions are provided courtesy of [uni
 	    def test_foo(self):
 	        self.assertEqual(9, 3 * 3, '3 x 3 should be 9')
 	        self.assertTrue(type(2) == int, '2 should be an integer')
 
 
 The API
 -------
 
-The full API documentation is found at
-<http://marionette-client.readthedocs.io>, but the key objects are:
+The full API documentation is found [here], but the key objects are:
 
   * `MarionetteTestCase`: a subclass for `unittest.TestCase`
     used as a base class for all tests to run.
 
   * [`Marionette`]: client that speaks to Firefox.
 
-[`Marionette`]: http://marionette-client.readthedocs.io/en/master/reference.html#marionette
+[here]: ../../../python/marionette_driver.html
+[`Marionette`]: ../../../python/marionette_driver.html#marionette_driver.marionette.Marionette
--- a/testing/marionette/puppeteer/firefox/docs/index.rst
+++ b/testing/marionette/puppeteer/firefox/docs/index.rst
@@ -10,17 +10,17 @@ make sense to use Firefox Puppeteer if:
 * You are manipulating something other than Firefox (like Firefox OS)
 * You are only manipulating elements in content scope (like a webpage)
 
 Roughly speaking, Firefox Puppeteer provides a library to manipulate each
 visual section of Firefox's browser UI. For example, there are different
 libraries for the tab bar, the navigation bar, etc.
 
 .. _Firefox Puppeteer: http://firefox-puppeteer.readthedocs.io/
-.. _Marionette Python client: http://marionette-client.readthedocs.org/
+.. _Marionette Python client: https://firefox-source-docs.mozilla.org/python/marionette_driver.html
 
 Installation
 ------------
 
 For end-users Firefox Puppeteer can be easily installed as a `Python package`_
 from PyPI. If you want to contribute to the project we propose that you clone
 the `mozilla-central`_ repository and run the following commands::
 
--- a/testing/web-platform/tests/docs/_writing-tests/testdriver-tutorial.md
+++ b/testing/web-platform/tests/docs/_writing-tests/testdriver-tutorial.md
@@ -234,17 +234,17 @@ class SeleniumProtocol(Protocol):
                   SeleniumSendKeysProtocolPart,
                   {... other protocol parts}
                   SeleniumSetWindowRectProtocolPart,
                   SeleniumTestDriverProtocolPart]
 ```
 
 
 ### Firefox
-We use the [set window rect](http://marionette-client.readthedocs.io/en/master/reference.html#marionette_driver.marionette.Marionette.set_window_rect) Marionette command.
+We use the [set window rect](https://firefox-source-docs.mozilla.org/python/marionette_driver.html#marionette_driver.marionette.Marionette.set_window_rect) Marionette command.
 
 We will use [executormarionette](tools/wptrunner/wptrunner/executors/executormarionette.py) and use the Marionette Python API.
 
 We have little actual work to do here! We just need to define a subclass of the protocol part we defined earlier.
 
 ```python
 class MarionetteSetWindowRectProtocolPart(SetWindowRectProtocolPart):
     def setup(self):