Commit Graph

35 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 57dd60c13f
doc: add troubleshooting hint to network-interface
closes #142
2016-07-15 13:18:33 +02:00
Patrick Kanzler 685a1f504c
DOC add image helper class 2016-06-23 15:38:55 +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 a0dc993f2f
DOC add example on printing commands from binary files 2016-05-01 15:27:15 +02:00
Patrick Kanzler 7547bfddd2
DOC fix underline length in doc 2016-04-02 15:27:47 +02:00
Davis Goglin 3ec00ae16e Remove unneeded requirements 2016-03-28 09:58:42 -07:00
Davis Goglin 2bb9756d28 Add documentation for config 2016-03-28 09:58:42 -07:00
Davis Goglin c26c875b61 Convert ini format to yaml format. 2016-03-28 09:58:42 -07:00
Davis Goglin 39e912bef4 I guess localconfig needs future 2016-03-28 09:58:42 -07:00
Davis Goglin 4548dd3830 Required for tests to pass 2016-03-28 09:58:42 -07:00
Davis Goglin ef31e58d26 Add base config documentation 2016-03-28 09:58:42 -07:00
Davis Goglin 73be1f2c48 Remove future from doc requirements. Doesn't need to be there 2016-03-28 09:58:42 -07:00
Davis Goglin 6096c15b80 Add future requirement to be able to use configparser 2016-03-28 09:58:42 -07:00
Patrick Kanzler 64e63b0180 PCKG automatically generate version from git-tags
* uses setuptools_scm
2016-03-11 14:46:36 +01:00
Patrick Kanzler e49c35abc1 PCKG fix setup.py and improve Manifest 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 1a2b8f1df2 PCKG refactor changelog and add to documentation 2016-03-11 14:46:36 +01:00
Patrick Kanzler 68641572f9 PCKG unify 'readme' in documentation and repository 2016-03-11 14:46:36 +01:00
Patrick Kanzler 7fdccb7245 PCKG add CONTRIBUTING document to repository and documentation 2016-03-11 14:46:35 +01:00
Patrick Kanzler 4cfc4fd564 DOC show inheritance of printer-objects in documentation 2016-03-08 20:06:38 +01:00
davisgoglin d9ffb03089 Update documentation for barcode function type B 2016-03-06 20:25:16 -08:00
Dean Rispin 8d00e63b87 Add width/height multiplier support, upsidedown text and text smoothing 2016-03-01 10:05:52 -08:00
Dean Rispin 7c98de6727 ADD inverted printing to set method 2016-02-29 20:56:45 +01:00
Patrick Kanzler f303a38a8d
DOC add captions to the toctrees in documentation 2016-02-16 22:55:49 +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 69680b04e9 DOC added notice on RS232 voltage levels
fixes #41
2016-01-06 12:13:35 +01:00
Patrick Kanzler c2b45748e1 DOC hide inherited members in printer-api 2016-01-05 23:58:40 +01:00
Patrick Kanzler 8b8ca76af6 DOC improve the documentation
* make API-doc more legible
* improve comments in methods
2016-01-05 23:14:35 +01:00
Patrick Kanzler e16e666dce DOC fix autodoc not working on RTD 2015-12-27 22:57:57 +01:00
Patrick Kanzler 50fbf2873f DOC improve api.rst 2015-12-27 19:39:22 +01:00
Patrick Kanzler ce0b0d5ba3 DOC improve documentation
* fixes #73
* links now to readthedocs instead of Wiki
2015-12-27 19:09:31 +01:00
Patrick Kanzler 8a77c963c3 DOC transfered wiki to sphinx-doc
* changed structure of index-file
* copied the WIKI at commit 67601b2d33f5a3cf8e9633e6ad92cca286840680
* adapted the markdown to rst
2015-12-27 19:01:05 +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