Commit Graph

9 Commits

Author SHA1 Message Date
Patrick Kanzler 9f5eed0020
add version-strings into the module
The version string is in the module as __version__ available.
In the doc the version will be automatically parsed. The version comes
from the installed module if on read the docs or directly from
setuptools_scm if you are working locally.
The CLI will issue the version string if you call it with the option
'version'. The CLI does not accept commands like '--version', since this
would not be conform with the rest of the interface (and argparse).

The configuration for loading the version-string is adapted from
pimutils/vdirsyncer. It autogenerates a version string setuptools_scm at
install-time and then adds it to the __version__ member in __init__.py

I adapted the GitHub-template with a fitting comment and bumped the
changelog.

closes #141
2016-07-17 19:39:42 +02:00
Patrick Kanzler 87438f9efa
SETUP move code to src
This way we can ensure that the packaged code is tested.
See https://hynek.me/articles/testing-packaging/ or c62a78c015

+ DOC adapt doc to new structure and test doc with travis
2016-06-20 17:48:14 +02:00
Patrick Kanzler 64e63b0180 PCKG automatically generate version from git-tags
* uses setuptools_scm
2016-03-11 14:46:36 +01:00
Patrick Kanzler f676782130 DOC add favicon 2016-03-11 14:46:36 +01:00
Patrick Kanzler 086b407b62 DOC use sphinx-rtd-theme even if built locally 2016-03-11 14:46:36 +01:00
Patrick Kanzler 4cfc4fd564 DOC show inheritance of printer-objects in documentation 2016-03-08 20:06:38 +01:00
Patrick Kanzler d00fc5016b DOC add a todo directive to the documentation
.. todo:: will create Todos that are listed in the TODO in the documentation
2016-01-14 00:53:44 +01:00
Patrick Kanzler e16e666dce DOC fix autodoc not working on RTD 2015-12-27 22:57:57 +01:00
Patrick Kanzler 06a68d1c97 DOC add very simple (and bad-looking) api-reference as doc-stub 2015-12-26 17:29:20 +01:00