Bug 1413575: Adjust in-tree references to mozbase documentation to point in-tree. draft
authorTom Prince <mozilla@hocat.ca>
Mon, 20 Nov 2017 11:43:13 -0700
changeset 700687 f9fa1e7e0380d8163d8a837df65909bbd26f2165
parent 700686 b310dc1df834b3f6ece68865a857674d3663b8b5
child 740968 b71d9c06328b8e3bc78adcb05b8ea5626dfe0b73
push id89937
push userbmo:mozilla@hocat.ca
push dateMon, 20 Nov 2017 19:10:11 +0000
bugs1413575
milestone59.0a1
Bug 1413575: Adjust in-tree references to mozbase documentation to point in-tree. MozReview-Commit-ID: rctbByyjTA
build/docs/test_manifests.rst
mobile/android/tests/browser/robocop/src/org/mozilla/gecko/StructuredLogger.java
testing/mozbase/README.md
testing/mozbase/manifestparser/setup.py
testing/mozbase/mozcrash/setup.py
testing/mozbase/mozdebug/setup.py
testing/mozbase/mozdevice/setup.py
testing/mozbase/mozfile/setup.py
testing/mozbase/mozhttpd/setup.py
testing/mozbase/mozinfo/setup.py
testing/mozbase/mozinstall/setup.py
testing/mozbase/mozleak/setup.py
testing/mozbase/mozlog/setup.py
testing/mozbase/moznetwork/setup.py
testing/mozbase/mozprocess/setup.py
testing/mozbase/mozprofile/setup.py
testing/mozbase/mozrunner/setup.py
testing/mozbase/mozscreenshot/setup.py
testing/mozbase/mozsystemmonitor/setup.py
testing/mozbase/moztest/setup.py
testing/mozbase/mozversion/setup.py
testing/web-platform/README.md
testing/web-platform/tests/tools/wptrunner/docs/conf.py
--- a/build/docs/test_manifests.rst
+++ b/build/docs/test_manifests.rst
@@ -34,17 +34,17 @@ xpcshell.ini
 .. _manifestparser_manifests:
 
 ManifestParser Manifests
 ==========================
 
 ManifestParser manifests are essentially ini files that conform to a basic
 set of assumptions.
 
-The `reference documentation <http://mozbase.readthedocs.org/en/latest/manifestparser.html>`_
+The :doc:`reference documentation </mozbase/manifestparser>`
 for manifestparser manifests describes the basic format of test manifests.
 
 In summary, manifests are ini files with section names describing test files::
 
     [test_foo.js]
     [test_bar.js]
 
 Keys under sections can hold metadata about each test::
--- a/mobile/android/tests/browser/robocop/src/org/mozilla/gecko/StructuredLogger.java
+++ b/mobile/android/tests/browser/robocop/src/org/mozilla/gecko/StructuredLogger.java
@@ -7,17 +7,17 @@ package org.mozilla.gecko;
 import java.util.HashSet;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import org.json.JSONObject;
 
-// This implements the structured logging API described here: http://mozbase.readthedocs.org/en/latest/mozlog_structured.html
+// This implements the structured logging API described here: https://firefox-source-docs.mozilla.org/mozbase/loggingreporting.html
 public class StructuredLogger {
     private final static HashSet<String> validTestStatus = new HashSet<String>(Arrays.asList("PASS", "FAIL", "TIMEOUT", "NOTRUN", "ASSERT"));
     private final static HashSet<String> validTestEnd = new HashSet<String>(Arrays.asList("PASS", "FAIL", "OK", "ERROR", "TIMEOUT",
                                                                                "CRASH", "ASSERT", "SKIP"));
 
     private String mName;
     private String mComponent;
     private LoggerCallback mCallback;
--- a/testing/mozbase/README.md
+++ b/testing/mozbase/README.md
@@ -10,12 +10,12 @@ Learn more about mozbase at the [project
 
 Read [detailed docs][] online, or build them locally by running "make html" in
 the docs directory.
 
 Consult [open][] [bugs][] and feel free to file [new bugs][].
 
 
 [project page]: https://wiki.mozilla.org/Auto-tools/Projects/Mozbase
-[detailed docs]: http://mozbase.readthedocs.org/
+[detailed docs]: https://firefox-source-docs.mozilla.org/mozbase/index.html
 [open]: https://bugzilla.mozilla.org/buglist.cgi?resolution=---&component=Mozbase&product=Testing
 [bugs]: https://bugzilla.mozilla.org/buglist.cgi?resolution=---&status_whiteboard_type=allwordssubstr&query_format=advanced&status_whiteboard=mozbase
 [new bugs]: https://bugzilla.mozilla.org/enter_bug.cgi?product=Testing&component=Mozbase
--- a/testing/mozbase/manifestparser/setup.py
+++ b/testing/mozbase/manifestparser/setup.py
@@ -7,17 +7,17 @@ from __future__ import absolute_import
 from setuptools import setup
 
 PACKAGE_NAME = "manifestparser"
 PACKAGE_VERSION = '1.2'
 
 setup(name=PACKAGE_NAME,
       version=PACKAGE_VERSION,
       description="Library to create and manage test manifests",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
                   # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla manifests',
       author='Mozilla Automation and Testing Team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozcrash/setup.py
+++ b/testing/mozbase/mozcrash/setup.py
@@ -12,17 +12,17 @@ PACKAGE_VERSION = '1.0'
 # dependencies
 deps = ['mozfile >= 1.0',
         'mozlog >= 3.0']
 
 setup(name=PACKAGE_NAME,
       version=PACKAGE_VERSION,
       description="Library for printing stack traces from minidumps "
       "left behind by crashed processes",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Tools team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozdebug/setup.py
+++ b/testing/mozbase/mozdebug/setup.py
@@ -7,17 +7,17 @@ from __future__ import absolute_import
 from setuptools import setup
 
 PACKAGE_VERSION = '0.1'
 
 setup(name='mozdebug',
       version=PACKAGE_VERSION,
       description="Utilities for running applications under native code debuggers "
       "intended for use in Mozilla testing",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Testing Team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozdevice/setup.py
+++ b/testing/mozbase/mozdevice/setup.py
@@ -14,17 +14,17 @@ deps = ['mozfile >= 1.0',
         'mozlog >= 3.0',
         'moznetwork >= 0.24',
         'mozprocess >= 0.19',
         ]
 
 setup(name=PACKAGE_NAME,
       version=PACKAGE_VERSION,
       description="Mozilla-authored device management",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='',
       author='Mozilla Automation and Testing Team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozfile/setup.py
+++ b/testing/mozbase/mozfile/setup.py
@@ -7,17 +7,17 @@ from __future__ import absolute_import
 from setuptools import setup
 
 PACKAGE_NAME = 'mozfile'
 PACKAGE_VERSION = '1.2'
 
 setup(name=PACKAGE_NAME,
       version=PACKAGE_VERSION,
       description="Library of file utilities for use in Mozilla testing",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Tools team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozhttpd/setup.py
+++ b/testing/mozbase/mozhttpd/setup.py
@@ -7,17 +7,17 @@ from __future__ import absolute_import
 from setuptools import setup
 
 PACKAGE_VERSION = '0.7'
 deps = ['moznetwork >= 0.24']
 
 setup(name='mozhttpd',
       version=PACKAGE_VERSION,
       description="Python webserver intended for use with Mozilla testing",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Testing Team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozinfo/setup.py
+++ b/testing/mozbase/mozinfo/setup.py
@@ -9,17 +9,17 @@ from setuptools import setup
 PACKAGE_VERSION = '0.10'
 
 # dependencies
 deps = ['mozfile >= 0.12']
 
 setup(name='mozinfo',
       version=PACKAGE_VERSION,
       description="Library to get system information for use in Mozilla testing",
-      long_description="see http://mozbase.readthedocs.org",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Testing Team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozinstall/setup.py
+++ b/testing/mozbase/mozinstall/setup.py
@@ -19,17 +19,17 @@ deps = ['mozinfo >= 0.7',
         'mozfile >= 1.0',
         'requests',
         'six >= 1.10.0',
         ]
 
 setup(name='mozInstall',
       version=PACKAGE_VERSION,
       description="package for installing and uninstalling Mozilla applications",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       classifiers=['Environment :: Console',
                    'Intended Audience :: Developers',
                    'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
                    'Natural Language :: English',
                    'Operating System :: OS Independent',
                    'Topic :: Software Development :: Libraries :: Python Modules',
                    'Programming Language :: Python :: 2.7',
--- a/testing/mozbase/mozleak/setup.py
+++ b/testing/mozbase/mozleak/setup.py
@@ -10,17 +10,17 @@ from setuptools import setup
 PACKAGE_NAME = 'mozleak'
 PACKAGE_VERSION = '0.1'
 
 
 setup(
     name=PACKAGE_NAME,
     version=PACKAGE_VERSION,
     description="Library for extracting memory leaks from leak logs files",
-    long_description="see http://mozbase.readthedocs.org/",
+    long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
     classifiers=['Programming Language :: Python :: 2.7',
                  'Programming Language :: Python :: 2 :: Only'],
     # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
     keywords='mozilla',
     author='Mozilla Automation and Tools team',
     author_email='tools@lists.mozilla.org',
     url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
     license='MPL',
--- a/testing/mozbase/mozlog/setup.py
+++ b/testing/mozbase/mozlog/setup.py
@@ -7,17 +7,17 @@ from __future__ import absolute_import
 from setuptools import setup, find_packages
 
 PACKAGE_NAME = 'mozlog'
 PACKAGE_VERSION = '3.5'
 
 setup(name=PACKAGE_NAME,
       version=PACKAGE_VERSION,
       description="Robust log handling specialized for logging in the Mozilla universe",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       author='Mozilla Automation and Testing Team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL 1.1/GPL 2.0/LGPL 2.1',
       packages=find_packages(),
       zip_safe=False,
       install_requires=["blessings>=1.3"],
       tests_require=['mozfile'],
--- a/testing/mozbase/moznetwork/setup.py
+++ b/testing/mozbase/moznetwork/setup.py
@@ -10,17 +10,17 @@ PACKAGE_VERSION = '0.27'
 
 deps = ['mozinfo',
         'mozlog >= 3.0',
         ]
 
 setup(name='moznetwork',
       version=PACKAGE_VERSION,
       description="Library of network utilities for use in Mozilla testing",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Tools team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozprocess/setup.py
+++ b/testing/mozbase/mozprocess/setup.py
@@ -6,17 +6,17 @@ from __future__ import absolute_import
 
 from setuptools import setup
 
 PACKAGE_VERSION = '0.25'
 
 setup(name='mozprocess',
       version=PACKAGE_VERSION,
       description="Mozilla-authored process handling",
-      long_description='see http://mozbase.readthedocs.org/',
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Environment :: Console',
                    'Intended Audience :: Developers',
                    'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
                    'Natural Language :: English',
                    'Operating System :: OS Independent',
                    'Programming Language :: Python',
                    'Topic :: Software Development :: Libraries :: Python Modules',
                    ],
--- a/testing/mozbase/mozprofile/setup.py
+++ b/testing/mozbase/mozprofile/setup.py
@@ -16,17 +16,17 @@ assert sys.version_info[0] == 2
 deps = ['mozfile >= 1.0',
         'mozlog >= 3.0',
         'six >= 1.10.0'
         ]
 
 setup(name=PACKAGE_NAME,
       version=PACKAGE_VERSION,
       description="Library to create and modify Mozilla application profiles",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Environment :: Console',
                    'Intended Audience :: Developers',
                    'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
                    'Natural Language :: English',
                    'Operating System :: OS Independent',
                    'Programming Language :: Python',
                    'Topic :: Software Development :: Libraries :: Python Modules',
                    ],
--- a/testing/mozbase/mozrunner/setup.py
+++ b/testing/mozbase/mozrunner/setup.py
@@ -23,17 +23,17 @@ deps = ['mozdevice >= 0.37',
 EXTRAS_REQUIRE = {'crash': ['mozcrash >= 1.0']}
 
 # we only support python 2 right now
 assert sys.version_info[0] == 2
 
 setup(name=PACKAGE_NAME,
       version=PACKAGE_VERSION,
       description=desc,
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Environment :: Console',
                    'Intended Audience :: Developers',
                    'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
                    'Natural Language :: English',
                    'Operating System :: OS Independent',
                    'Programming Language :: Python',
                    'Topic :: Software Development :: Libraries :: Python Modules',
                    ],
--- a/testing/mozbase/mozscreenshot/setup.py
+++ b/testing/mozbase/mozscreenshot/setup.py
@@ -10,17 +10,17 @@ from setuptools import setup
 PACKAGE_NAME = 'mozscreenshot'
 PACKAGE_VERSION = '0.1'
 
 
 setup(
     name=PACKAGE_NAME,
     version=PACKAGE_VERSION,
     description="Library for taking screenshots in tests harness",
-    long_description="see http://mozbase.readthedocs.org/",
+    long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
     classifiers=['Programming Language :: Python :: 2.7',
                  'Programming Language :: Python :: 2 :: Only'],
     # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
     keywords='mozilla',
     author='Mozilla Automation and Tools team',
     author_email='tools@lists.mozilla.org',
     url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
     license='MPL',
--- a/testing/mozbase/mozsystemmonitor/setup.py
+++ b/testing/mozbase/mozsystemmonitor/setup.py
@@ -14,17 +14,17 @@ try:
     pwd = os.path.dirname(os.path.abspath(__file__))
     description = open(os.path.join(pwd, 'README.rst')).read()
 except:
     description = ''
 
 setup(
     name='mozsystemmonitor',
     description='Monitor system resource usage.',
-    long_description=description,
+    long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
     license='MPL 2.0',
     keywords='mozilla',
     author='Mozilla Automation and Tools Team',
     author_email='tools@lists.mozilla.org',
     url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
     packages=['mozsystemmonitor'],
     version=PACKAGE_VERSION,
     install_requires=['psutil >= 3.1.1'],
--- a/testing/mozbase/moztest/setup.py
+++ b/testing/mozbase/moztest/setup.py
@@ -9,17 +9,17 @@ from setuptools import setup, find_packa
 PACKAGE_VERSION = '0.8'
 
 # dependencies
 deps = ['mozinfo']
 
 setup(name='moztest',
       version=PACKAGE_VERSION,
       description="Package for storing and outputting Mozilla test results",
-      long_description="see http://mozbase.readthedocs.org/",
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=['Programming Language :: Python :: 2.7',
                    'Programming Language :: Python :: 2 :: Only'],
       # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='mozilla',
       author='Mozilla Automation and Tools team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
--- a/testing/mozbase/mozversion/setup.py
+++ b/testing/mozbase/mozversion/setup.py
@@ -7,17 +7,17 @@ from __future__ import absolute_import
 from setuptools import setup
 
 PACKAGE_VERSION = '1.4'
 
 
 setup(name='mozversion',
       version=PACKAGE_VERSION,
       description='Library to get version information for applications',
-      long_description='See http://mozbase.readthedocs.org',
+      long_description="see https://firefox-source-docs.mozilla.org/mozbase/index.html",
       classifiers=[],
       keywords='mozilla',
       author='Mozilla Automation and Testing Team',
       author_email='tools@lists.mozilla.org',
       url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
       license='MPL',
       packages=['mozversion'],
       include_package_data=True,
--- a/testing/web-platform/README.md
+++ b/testing/web-platform/README.md
@@ -115,17 +115,17 @@ but otherwise fails:
 
     [filename.html]
         type: reftest
         expected:
             if os == "linux": TIMEOUT
             FAIL
 
 The available variables for the conditions are those provided by
-[mozinfo](http://mozbase.readthedocs.org/en/latest/mozinfo.html).
+[mozinfo](https://firefox-source-docs.mozilla.org/mozbase/mozinfo.html).
 
 For more information on manifest files, see the
 [wptrunner documentation](http://wptrunner.readthedocs.org/en/latest/expectation.html).
 
 Autogenerating Expectation Data
 -------------------------------
 
 After changing some code it may be necessary to update the expectation
--- a/testing/web-platform/tests/tools/wptrunner/docs/conf.py
+++ b/testing/web-platform/tests/tools/wptrunner/docs/conf.py
@@ -259,9 +259,9 @@ texinfo_documents = [
 #texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'python': ('http://docs.python.org/', None),
-                       'mozlog': ('http://mozbase.readthedocs.org/en/latest/', None)}
+                       'mozlog': ('https://firefox-source-docs.mozilla.org/', None)}