diff options
author | Markus Holtermann <info@markusholtermann.eu> | 2014-10-08 00:53:41 +0200 |
---|---|---|
committer | Markus Holtermann <info@markusholtermann.eu> | 2014-10-08 00:55:03 +0200 |
commit | 913cc85e6467f723f36709f13cd52dd0148fc38b (patch) | |
tree | 280f95d9b19e390f6d6de085822b313aa7135db6 | |
parent | 819ca3ea5848b605bf87221721297fb24131e408 (diff) | |
download | bvg-grabber-913cc85e6467f723f36709f13cd52dd0148fc38b.tar.gz bvg-grabber-913cc85e6467f723f36709f13cd52dd0148fc38b.tar.bz2 bvg-grabber-913cc85e6467f723f36709f13cd52dd0148fc38b.zip |
Update docs
-rw-r--r-- | CHANGES.rst | 19 | ||||
-rw-r--r-- | docs/conf.py | 2 | ||||
-rw-r--r-- | docs/source/changes.rst | 1 | ||||
-rw-r--r-- | docs/source/index.rst | 6 | ||||
-rw-r--r-- | docs/source/readme.rst | 1 |
5 files changed, 27 insertions, 2 deletions
diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..2392787 --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,19 @@ +======= +Changes +======= + + +v0.1.1 (2014-10-08) +=================== + +* Added installation instructions (#6) +* Added usage documentation +* Updated links to presentation (#7) +* Updated READ-ME +* Updated ``bvg-grabber.py`` help + + +v0.1 (2014-09-19) +================= + +* Initial release diff --git a/docs/conf.py b/docs/conf.py index ec71904..443eae9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -126,7 +126,7 @@ html_theme = 'nature' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['source/_static'] +#html_static_path = ['source/_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/docs/source/changes.rst b/docs/source/changes.rst new file mode 100644 index 0000000..d76c92b --- /dev/null +++ b/docs/source/changes.rst @@ -0,0 +1 @@ +.. include:: ../../CHANGES.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 090a43d..ccf1062 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,10 +9,14 @@ Welcome to BVG-Grabber's documentation! Contents: .. toctree:: + :maxdepth: 2 + + readme + ref/api ref/utils - :maxdepth: 2 + changes Indices and tables diff --git a/docs/source/readme.rst b/docs/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/docs/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst |