Merge pull request #36 from 1138-4EB/patch-1

Update README according to #35

Author: ericholscher

README.rst

@@ -1,14 +1,9 @@
 Read the Docs Builder
 =====================
 
-This module is the main building interface to Read the Docs.
-It has no explicit dependency on RTD code itself,
-and can be used outside of RTD to test your builds.
-
 .. warning::
-    This code is still under active development and isn't considered
-    stable. Please report bugs you find and contribute back if you are so
-    inclined.
+   This repo is only used as a configuration parser for readthedocs.org builds,
+   and it's unsupported for other uses.
 
 Install
 -------
@@ -17,57 +12,14 @@ Install with pip::
 
     pip install readthedocs-build
 
-CLI Use
--------
-
-Running a build is simple::
-
-    rtd-build
-
-This will search for all ``readthedocs.yml`` (or ``.readthedocs.yml``) files
-below your current directory and will build your documentation.
-
-You can set a specific a directory where the built documentation should be
-stored::
-
-    rtd-build --outdir=out_dir
-
-The documentation will then be placed in `out_dir/<name>/html/`. Where `<name>`
-is the name configured in your `readthedocs.yml`. The default for ``--outdir``
-is `_readthedocs_build`.
-
-Run `rtd-build --help` for more information.
-
-The Build
----------
-
-Here is a list of steps that `rtd-build` performs to built your documentation.
-All these steps are performed for each individual section in your
-``readthedocs.yml`` configs.
-
-- it creates a new virtual environment with ``virtualenv``
-- it installs the builder's dependencies into the virtualenv, for example
-  ``Sphinx``
-- it runs the build command (e.g. ``sphinx-build``) on your documentation and
-  puts the output into the directory specified with ``--outdir``.
-- it removes the virtualenv
-
 Library Use
 -----------
 
-An example use of this library is:
-
-.. code-block:: python
+Example uses of this library is:
 
-    import os
-    from readthedocs_build.build import build
+* https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/config.py#L8-L9
+* https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/projects/tasks.py#L27
 
-    build([{
-        'output_base': os.path.abspath('outdir'),
-        'name': 'docs',
-        'type': 'sphinx',
-        'base': os.path.dirname(os.path.abspath(__file__)),
-    }])
 
 Development
 -----------
@@ -82,13 +34,3 @@ changes as you edit them in the code.
 To run the tests::
 
     tox
-
-Build Process
--------------
-
-Read the Docs creates a full environment for your build. In your local
-environment, you can choose what portions of this environment to re-create.
-You can either use your existing environment with our builder code installed,
-or allow our builder to create a fully isolated environment for itself. A fully
-isolated environment is much closer to our production build environment for
-testing purposes.