docs: move testing documentation to Sphinx
authorGregory Szorc <gps@mozilla.com>
Thu, 16 Oct 2014 12:02:06 -0700
changeset 359734 2901bf0f55367a6951d05b48aaeb541345ce913e
parent 359733 2224825bc2d2b779b8b2b85de1f8ec02e4fef97c
child 359735 c31184c5874e11725f3ede3d625cd66cd542109e
push id16998
push userrwood@mozilla.com
push dateMon, 02 May 2016 19:42:03 +0000
docs: move testing documentation to Sphinx
README.rst
docs/index.rst
docs/testing.rst
--- a/README.rst
+++ b/README.rst
@@ -100,64 +100,8 @@ The serverlog extension hacks up some Me
 forensics that are useful for Mercurial server operators.
 
 Hooks
 =====
 
 The hghooks directory contains various Mercurial hooks. The content of
 this directory originally derived from its own repository. Changesets
 e11fee681380 through 1f927bcba52c contain the import of this repository.
-
-Testing
-=======
-
-This repository contains extensive tests of the functionality therein.
-To run the tests, you'll need a Linux or OS X install. You can always
-obtain a Linux install by running a virtual machine.
-
-Testing requires a special Python environment. To create this
-environment:
-
-  $ ./create-test-environment
-  $ source venv/bin/activate
-
-Then, launch the tests:
-
-  $ ./run-mercurial-tests.py
-
-To see help on options that control execution:
-
-  $ ./run-mercurial-tests.py --help
-
-Unknown script arguments will be proxied to Mercurial's ``run-tests.py``
-testing harness.
-
-Common tasks are described in the sections below.
-
-Run all tests, 8 at a time
---------------------------
-
-  $ ./run-mercurial-tests -j8
-
-Obtain code coverage results (makes tests run slower)
------------------------------------------------------
-
-  $ ./run-mercurial-tests --cover
-
-Test a single file
-------------------
-
-  $ ./run-mercurial-tests path/to/test.t
-
-Run a test in debug mode
-------------------------
-
-  $ ./run-mercurial-tests -d path/to/test.t
-
-Run tests against all supported Mercurial versions
---------------------------------------------------
-
-  $ ./run-mercurial-tests --all-versions
-
-Run tests with a specific Mercurial installation
-------------------------------------------------
-
-  $ ./run-mercurial-tests --with-hg=/path/to/hg
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,21 +1,20 @@
-.. Mozilla Version Control Tools documentation master file, created by
-   sphinx-quickstart on Thu Oct 16 11:29:01 2014.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. _index:
 
-Welcome to Mozilla Version Control Tools's documentation!
-=========================================================
+Mozilla's Version Control Tools
+===============================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   testing
+
 
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
new file mode 100644
--- /dev/null
+++ b/docs/testing.rst
@@ -0,0 +1,51 @@
+.. _testing:
+
+Testing
+=======
+
+This repository contains extensive tests of the functionality therein.
+To run the tests, you'll need a Linux or OS X install. You can always
+obtain a Linux install by running a virtual machine.
+
+Testing requires a special Python environment. To create this
+environment::
+
+  $ ./create-test-environment
+  $ source venv/bin/activate
+
+Then, launch the tests::
+
+   $ ./run-mercurial-tests.py
+
+To see help on options that control execution::
+
+   $ ./run-mercurial-tests.py --help
+
+Unknown script arguments will be proxied to Mercurial's ``run-tests.py``
+testing harness.
+
+Common tasks are described below.
+
+Run all tests, 8 at a time::
+
+  $ ./run-mercurial-tests -j8
+
+Obtain code coverage results (makes tests run slower)::
+
+  $ ./run-mercurial-tests --cover
+
+Test a single file::
+
+  $ ./run-mercurial-tests path/to/test.t
+
+Run a test in debug mode::
+
+  $ ./run-mercurial-tests -d path/to/test.t
+
+Run tests against all supported Mercurial versions::
+
+  $ ./run-mercurial-tests --all-versions
+
+Run tests with a specific Mercurial installation::
+
+  $ ./run-mercurial-tests --with-hg=/path/to/hg