Browse Source

[IMP] README bits

pull/1/head
Xavier Morel 4 years ago
parent
commit
a7cf24ecb8
1 changed files with 9 additions and 4 deletions
  1. 9
    4
      README.rst

+ 9
- 4
README.rst View File

@@ -13,13 +13,18 @@ Building requirements:

$ sphinx-build --version

After checking out, at the root of the documentation just type
See `the sphinx documentation <http://sphinx-doc.org/install.html>`_
for local installation instructions.
* `git <http://www.git-scm.com>`_
* clone this repository using git, then at the root of the repository,
in a console,

.. code-block:: console
.. code-block:: console

$ make html
$ make html

the HTML content will be built to ``_build/html/index.html``.
this should compile the documentation to HTML, and put the generated
HTML in ``_build/html/index.html``.

Contributions
=============

Loading…
Cancel
Save