From 913cc85e6467f723f36709f13cd52dd0148fc38b Mon Sep 17 00:00:00 2001 From: Markus Holtermann Date: Wed, 8 Oct 2014 00:53:41 +0200 Subject: Update docs --- CHANGES.rst | 19 +++++++++++++++++++ docs/conf.py | 2 +- docs/source/changes.rst | 1 + docs/source/index.rst | 6 +++++- docs/source/readme.rst | 1 + 5 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 CHANGES.rst create mode 100644 docs/source/changes.rst create mode 100644 docs/source/readme.rst 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 -- cgit v1.2.3