Skip to content

Commit

Permalink
Generated HTML docs and removed documentation.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
micheles committed Jul 26, 2015
1 parent bd0f62e commit 24d5f15
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 1,827 deletions.
20 changes: 10 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
RST=python $(S)/ms/tools/rst.py
RST=$(S)/ms/tools/rst.py -H

rst: src/tests/documentation.py
PYTHONPATH=src:$(S) python3 $(S)/minidoc3.py -d tests.documentation
cp /tmp/tests.documentation.rst docs/documentation.rst
PYTHONPATH=src:$(S) $(S)/ms/tools/minidoc.py -d tests.documentation

html: docs/documentation.rst README.rst
$(RST) docs/documentation.rst
rst2html README.rst docs/index.html
html: /tmp/tests.documentation.rst docs/README.rst
$(RST) /tmp/tests.documentation.rst
$(RST) docs/README.rst
mv docs/README.html docs/index.html
mv /tmp/tests.documentation.html docs/documentation.html

pdf: docs/documentation.rst
rst2pdf docs/documentation.rst -o docs/documentation.pdf
pdf: /tmp/tests.documentation.rst
rst2pdf /tmp/tests.documentation.rst -o documentation.pdf

upload: documentation.pdf
git clean -f
upload: documentation.pdf docs/index.html
python3 setup.py register sdist bdist_wheel upload upload_docs
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[See the real README](README.rst)
[See the real README](docs/README.rst)

[![Build Status](https://secure.travis-ci.org/micheles/decorator.png?branch=master)](https://travis-ci.org/micheles/decorator)
6 changes: 3 additions & 3 deletions README.rst → docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ the documentation, download the tarball_, unpack it and run
in the main directory, possibly as superuser.

.. _tarball: http://pypi.python.org/pypi/decorator
.. _distribute: http://packages.python.org/distribute/


Testing
--------
Expand All @@ -51,8 +51,8 @@ There are various versions of the documentation:
- `HTML version`_
- `PDF version`_

.. _HTML version: https://github.com/micheles/decorator/blob/4.0.0/docs/documentation.rst
.. _PDF version: https://github.com/micheles/decorator/blob/4.0.0/docs/documentation.pdf
.. _HTML version: http://pypi.python.org/pypi/decorator/documentation.html
.. _PDF version: https://github.com/micheles/decorator/blob/4.0.1/documentation.pdf

Repository
---------------
Expand Down
Loading

0 comments on commit 24d5f15

Please sign in to comment.