Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gbroques committed Mar 30, 2018
1 parent ff2f986 commit 6c4a47a
Showing 1 changed file with 10 additions and 22 deletions.
32 changes: 10 additions & 22 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,24 @@
We automatically generate our documentation with a tool called [Sphinx](http://www.sphinx-doc.org/en/master/).

A Sphinx extension, called [sphinx-apidoc](http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html),
automatically generates Sphinx sources as reStructuredText or `.rst` files from the code.
automatically generates Sphinx sources as reStructuredText or `.rst` files from the `song_match` package.

For a primer on reStructuredText (rst) view Sphinx's [reStructuredText Primer](http://www.sphinx-doc.org/en/stable/rest.html#rst-primer).
For a primer on reStructuredText see Sphinx's [reStructuredText Primer](http://www.sphinx-doc.org/en/stable/rest.html#rst-primer).

We then post-process reStructuredText with a python script called `prettify_doc.py` which:
We then post-process the reStructuredText files with a python script called `prettify_doc.py`. For details, see `prettify_doc.py`.

* Moves the *Module Contents" section to the top.
* And removes headers for "Module Contents", "Submodules" and "Subpackages",
including their underlines and the following blank line.
Finally, Sphinx creates the HTML and other necessary files in `docs/_build`.

Finally, the HTML and other necessary components are built with Sphinx.
You can run `docs/make_docs` which automates the above process.

We host our documentation with a free service called [Read the Docs](https://readthedocs.org/).
We host our documentation using a free service called [Read the Docs](https://readthedocs.org/).

## How to Update the Docs

Make your desired changes.
1. Make your desired changes.

Then run the bash script:
2. Run `./docs/make_docs`

`./docs/make_docs`
3. Verify your changes by opening `docs/_build/html/index.html` in your favorite web browser.

This will do the following:

1. Generate reStructuredText from the `song_match` package with `sphinx-apidoc`.
2. Post-process the reStructuredText files with `prettify_doc.py`.
3. Run `make html` to output the HTML and other necessary files in the `docs/_build` directory.

Verify your changes by opening `docs/_build/html/index.html` in your favorite web browser.

Commit and push your changes.

Read the Docs will then update the docs upon pushing your changes to the repository.
4. Commit, and push your changes. Read the Docs will update the documentation site upon pushing.

0 comments on commit 6c4a47a

Please sign in to comment.