Commit 73ba427b authored by JC Brand's avatar JC Brand

Add Make recipes for buildout and Sphinx and update docs

parent d109f0a9
...@@ -234,8 +234,17 @@ check: eslint ...@@ -234,8 +234,17 @@ check: eslint
######################################################################## ########################################################################
## Documentation ## Documentation
./bin/activate:
virtualenv .
.installed.cfg: requirements.txt buildout.cfg
./bin/pip install -r requirements.txt
./bin/buildout -v
docsdev: ./bin/activate .installed.cfg
.PHONY: html .PHONY: html
html: apidoc html: docsdev apidoc
rm -rf $(BUILDDIR)/html rm -rf $(BUILDDIR)/html
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
make apidoc make apidoc
......
...@@ -30,33 +30,20 @@ under ``docs/source``. ...@@ -30,33 +30,20 @@ under ``docs/source``.
How to generate HTML from the source files? How to generate HTML from the source files?
=========================================== ===========================================
Install Dependencies
--------------------
In order to generate HTML from the source files, you need to have Sphinx and
the `Sphinx Bootstrap Theme <http://ryan-roemer.github.io/sphinx-bootstrap-theme>`_
installed.
We use `zc.buildout <http://www.buildout.org/en/latest/>`_ to install Sphinx
and the theme.
To install Sphinx, do the following inside the Converse repo::
virtualenv .
source bin/activate
pip install -r requirements.txt
./bin/buildout
Generate the HTML Generate the HTML
----------------- -----------------
After installing the dependencies, you can generate the HTML by simply After installing the dependencies, you can generate the HTML by running::
running::
make html make html
The HTMl files will be located in ``./docs/html`` The HTMl files will be located in ``./docs/html``
What ``make html`` does for you is it installs `zc.buildout <http://www.buildout.org/en/latest/>`_
which is used to install Sphinx and all its dependencies.
You'll need to have Python and `Virtualenv <https://virtualenv.pypa.io/en/latest/>`_ available on your computer.
.. warning:: When contributing, please don't commit any generated html files. .. warning:: When contributing, please don't commit any generated html files.
Serving the documentation Serving the documentation
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment