Mercurial > public > enigma
changeset 45:19d33ff901af
Add more read the docs links in README. Adjust MANIFEST.in for docs.
| author | Brian Neal <bgneal@gmail.com> |
|---|---|
| date | Tue, 05 Jun 2012 18:18:28 -0500 |
| parents | f2399d731ee1 |
| children | ad9d606ef5fa |
| files | MANIFEST.in README.txt |
| diffstat | 2 files changed, 7 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/MANIFEST.in Mon Jun 04 21:09:34 2012 -0500 +++ b/MANIFEST.in Tue Jun 05 18:18:28 2012 -0500 @@ -1,2 +1,4 @@ include *.txt recursive-include enigma/examples * +recursive-include enigma/docs *.txt *.py *.rst +prune enigma/docs/build
--- a/README.txt Mon Jun 04 21:09:34 2012 -0500 +++ b/README.txt Tue Jun 05 18:18:28 2012 -0500 @@ -94,13 +94,6 @@ requirements or dependencies. -Project Status --------------- - -This project is very new and is considered alpha software. However at even this -stage it is possible to encrypt and decrypt authentic Enigma messages. - - Installation ------------ @@ -120,8 +113,11 @@ Documentation ------------- -The latest documentation is available at -`Read the Docs <http://readthedocs.org/docs/py-enigma/en/latest/>`_. +The latest documentation is available at `Read the Docs +<http://readthedocs.org/projects/py-enigma/>`_. There you can `browse the +documentation online <http://readthedocs.org/docs/py-enigma/en/latest/>`_, or +`download it in a variety of formats +<http://readthedocs.org/projects/py-enigma/downloads/>`_. Sources for the documentation are also included in Sphinx_ format. If you install Sphinx you can generate the documentation in several output formats.