gntplib 0.63__tar.gz → 0.66__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of gntplib might be problematic. Click here for more details.

Files changed (69) hide show
  1. {gntplib-0.63 → gntplib-0.66}/MANIFEST.in +4 -4
  2. gntplib-0.66/PKG-INFO +118 -0
  3. {gntplib-0.63 → gntplib-0.66}/README.rst +93 -93
  4. gntplib-0.66/__version__.py +1 -0
  5. {gntplib-0.63 → gntplib-0.66}/docs/Makefile +153 -153
  6. {gntplib-0.63 → gntplib-0.66}/docs/api.rst +68 -68
  7. {gntplib-0.63 → gntplib-0.66}/docs/async.rst +67 -67
  8. gntplib-0.66/docs/build/.buildinfo +4 -0
  9. gntplib-0.66/docs/build/.doctrees/api.doctree +0 -0
  10. gntplib-0.66/docs/build/.doctrees/async.doctree +0 -0
  11. gntplib-0.66/docs/build/.doctrees/environment.pickle +0 -0
  12. gntplib-0.66/docs/build/.doctrees/index.doctree +0 -0
  13. gntplib-0.66/docs/build/.doctrees/installation.doctree +0 -0
  14. gntplib-0.66/docs/build/.doctrees/usage.doctree +0 -0
  15. gntplib-0.66/docs/build/_sources/api.rst.txt +68 -0
  16. gntplib-0.66/docs/build/_sources/async.rst.txt +67 -0
  17. gntplib-0.66/docs/build/_sources/index.rst.txt +26 -0
  18. gntplib-0.66/docs/build/_sources/installation.rst.txt +19 -0
  19. gntplib-0.66/docs/build/_sources/usage.rst.txt +250 -0
  20. gntplib-0.66/docs/build/_static/basic.css +925 -0
  21. gntplib-0.66/docs/build/_static/contents.png +0 -0
  22. gntplib-0.66/docs/build/_static/doctools.js +156 -0
  23. gntplib-0.66/docs/build/_static/documentation_options.js +13 -0
  24. gntplib-0.66/docs/build/_static/file.png +0 -0
  25. gntplib-0.66/docs/build/_static/language_data.js +199 -0
  26. gntplib-0.66/docs/build/_static/minus.png +0 -0
  27. gntplib-0.66/docs/build/_static/navigation.png +0 -0
  28. gntplib-0.66/docs/build/_static/plus.png +0 -0
  29. gntplib-0.66/docs/build/_static/pygments.css +75 -0
  30. gntplib-0.66/docs/build/_static/searchtools.js +619 -0
  31. gntplib-0.66/docs/build/_static/sphinx_highlight.js +154 -0
  32. gntplib-0.66/docs/build/_static/sphinxdoc.css +354 -0
  33. gntplib-0.66/docs/build/api/index.html +459 -0
  34. gntplib-0.66/docs/build/async/index.html +168 -0
  35. gntplib-0.66/docs/build/genindex/index.html +222 -0
  36. gntplib-0.66/docs/build/index.html +154 -0
  37. gntplib-0.66/docs/build/installation/index.html +119 -0
  38. gntplib-0.66/docs/build/objects.inv +8 -0
  39. gntplib-0.66/docs/build/search/index.html +92 -0
  40. gntplib-0.66/docs/build/searchindex.js +1 -0
  41. gntplib-0.66/docs/build/usage/index.html +350 -0
  42. {gntplib-0.63 → gntplib-0.66}/docs/conf.py +245 -245
  43. {gntplib-0.63 → gntplib-0.66}/docs/index.rst +26 -26
  44. {gntplib-0.63 → gntplib-0.66}/docs/installation.rst +19 -19
  45. {gntplib-0.63 → gntplib-0.66}/docs/locale/ja/LC_MESSAGES/api.po +258 -258
  46. {gntplib-0.63 → gntplib-0.66}/docs/locale/ja/LC_MESSAGES/async.po +119 -119
  47. {gntplib-0.63 → gntplib-0.66}/docs/locale/ja/LC_MESSAGES/index.po +42 -42
  48. {gntplib-0.63 → gntplib-0.66}/docs/locale/ja/LC_MESSAGES/installation.po +53 -53
  49. {gntplib-0.63 → gntplib-0.66}/docs/locale/ja/LC_MESSAGES/usage.po +434 -434
  50. {gntplib-0.63 → gntplib-0.66}/docs/make.bat +190 -190
  51. {gntplib-0.63 → gntplib-0.66}/docs/usage.rst +250 -250
  52. {gntplib-0.63 → gntplib-0.66}/gntplib/__init__.py +973 -973
  53. gntplib-0.66/gntplib/__version__.py +1 -0
  54. {gntplib-0.63 → gntplib-0.66}/gntplib/async.py +193 -193
  55. {gntplib-0.63 → gntplib-0.66}/gntplib/ciphers.py +97 -97
  56. {gntplib-0.63 → gntplib-0.66}/gntplib/compat.py +9 -9
  57. {gntplib-0.63 → gntplib-0.66}/gntplib/exceptions.py +5 -5
  58. {gntplib-0.63 → gntplib-0.66}/gntplib/keys.py +79 -79
  59. {gntplib-0.63 → gntplib-0.66}/gntplib/utils.py +11 -11
  60. gntplib-0.66/gntplib.egg-info/PKG-INFO +118 -0
  61. gntplib-0.66/gntplib.egg-info/SOURCES.txt +65 -0
  62. {gntplib-0.63 → gntplib-0.66}/setup.cfg +13 -13
  63. {gntplib-0.63 → gntplib-0.66}/setup.py +39 -35
  64. gntplib-0.63/PKG-INFO +0 -116
  65. gntplib-0.63/gntplib.egg-info/PKG-INFO +0 -116
  66. gntplib-0.63/gntplib.egg-info/SOURCES.txt +0 -29
  67. {gntplib-0.63 → gntplib-0.66}/gntplib.egg-info/dependency_links.txt +0 -0
  68. {gntplib-0.63 → gntplib-0.66}/gntplib.egg-info/requires.txt +0 -0
  69. {gntplib-0.63 → gntplib-0.66}/gntplib.egg-info/top_level.txt +0 -0
@@ -1,4 +1,4 @@
1
- include README.rst
2
- recursive-include docs *
3
- recursive-exclude docs *.mo
4
- prune docs/_build
1
+ include README.rst __version__.py
2
+ recursive-include docs *
3
+ recursive-exclude docs *.mo
4
+ prune docs/_build
gntplib-0.66/PKG-INFO ADDED
@@ -0,0 +1,118 @@
1
+ Metadata-Version: 2.1
2
+ Name: gntplib
3
+ Version: 0.66
4
+ Summary: A Growl Notification Transport Protocol (GNTP) client library in Python
5
+ Home-page: http://github.com/papaeye/gntplib
6
+ Author: papaeye
7
+ Author-email: papaeye@gmail.com
8
+ License: BSD License
9
+ Keywords: gntp growl async
10
+ Platform: any
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: License :: OSI Approved :: BSD License
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python
16
+ Classifier: Programming Language :: Python :: 2
17
+ Classifier: Programming Language :: Python :: 2.7
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.2
20
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
21
+ Provides-Extra: async
22
+ Requires-Dist: tornado; extra == "async"
23
+ Provides-Extra: ciphers
24
+ Requires-Dist: pycrypto; extra == "ciphers"
25
+
26
+ gntplib
27
+ =======
28
+
29
+ gntplib is a Growl Notification Transport Protocol (GNTP_) client library in
30
+ Python.
31
+
32
+ gntplib is tested on Python 2.7/3.2, Growl_ 1.3.3 and
33
+ `Growl for Windows`_ 2.0.9.
34
+
35
+ .. _GNTP: http://www.growlforwindows.com/gfw/help/gntp.aspx
36
+ .. _Growl: http://growl.info/
37
+ .. _Growl for Windows: http://www.growlforwindows.com/
38
+
39
+ Installation
40
+ ------------
41
+
42
+ Simply use pip::
43
+
44
+ $ pip install gntplib
45
+
46
+ There are the following **optional** prerequisites.
47
+
48
+ * ``pycrypto`` - to use ``gntplib.ciphers`` module for message encryption
49
+ * ``tornado`` - to use ``gntplib.async`` module for asynchronous processing
50
+
51
+ Documentation
52
+ -------------
53
+
54
+ Release version: http://packages.python.org/gntplib/ (`ja
55
+ <http://packages.python.org/gntplib/ja/>`_)
56
+
57
+ Development version: http://gntplib.readthedocs.org/en/latest/
58
+
59
+ History
60
+ -------
61
+
62
+ 0.5 (2012-04-13)
63
+ ~~~~~~~~~~~~~~~~
64
+
65
+ * Support ``SUBSCRIBE`` request.
66
+
67
+ - Add ``gntplib.subscribe()``, ``gntplib.Subscriber`` and
68
+ ``gntplib.async.AsyncSubscriber``.
69
+
70
+ * Support Custom Headers and App-Specific Headers.
71
+
72
+ * Deprecate ``gntplib.notify()``, ``gntplib.Notifier()`` and
73
+ ``gntplib.AsyncNotifier()`` in favor of ``gntplib.publish()``,
74
+ ``gntplib.Publisher()`` and ``gntplib.async.AsyncPublisher()``.
75
+
76
+ * Deprecate ``gntplib.RawIcon`` and ``gntplib.async.AsyncIcon`` in favor of
77
+ ``gntplib.Resource`` and ``gntplib.async.AsyncResource``.
78
+
79
+ 0.4 (2012-04-07)
80
+ ~~~~~~~~~~~~~~~~
81
+
82
+ * Support password and encryption
83
+ * Support Growl for Windows
84
+
85
+ 0.3 (2012-03-30)
86
+ ~~~~~~~~~~~~~~~~
87
+
88
+ * Support Python 3
89
+
90
+ 0.2 (2012-03-18)
91
+ ~~~~~~~~~~~~~~~~
92
+
93
+ * Add support for asynchronous processing built on Tornado.
94
+
95
+ - Add ``gntplib.async.AsyncNotifier`` and ``gntplib.async.AsyncIcon``.
96
+
97
+ * Imporve usability of callback.
98
+
99
+ - ``SocketCallback``: Now ``SocketCallback`` is not a abstract class, but
100
+ represents a socket callback. Its ``if_clicked``, ``if_closed`` and
101
+ ``if_timedout`` methods are replaced with ``on_click``, ``on_close`` and
102
+ ``on_timeout`` methods respectively, which can be set at the constructor.
103
+
104
+ - ``Notifier.notify()``: Redefine ``callback`` argument as for the callback
105
+ to run after closing the connection with the GNTP server.
106
+ Add ``gntp_callback`` argument for url callback (as string) and socket
107
+ callback (as ``SocketCallback`` instance).
108
+ Add ``context``, ``context_type``, ``on_click``, ``on_close`` and
109
+ ``on_timeout`` arguments to define a socket callback easily.
110
+
111
+ * Remove ``callback`` argument from ``gntplib.notify()``.
112
+
113
+ * Rename ``gntplib.Icon`` to ``gntplib.RawIcon``.
114
+
115
+ 0.1 (2012-03-12)
116
+ ~~~~~~~~~~~~~~~~
117
+
118
+ * Initial release.
@@ -1,93 +1,93 @@
1
- gntplib
2
- =======
3
-
4
- gntplib is a Growl Notification Transport Protocol (GNTP_) client library in
5
- Python.
6
-
7
- gntplib is tested on Python 2.7/3.2, Growl_ 1.3.3 and
8
- `Growl for Windows`_ 2.0.9.
9
-
10
- .. _GNTP: http://www.growlforwindows.com/gfw/help/gntp.aspx
11
- .. _Growl: http://growl.info/
12
- .. _Growl for Windows: http://www.growlforwindows.com/
13
-
14
- Installation
15
- ------------
16
-
17
- Simply use pip::
18
-
19
- $ pip install gntplib
20
-
21
- There are the following **optional** prerequisites.
22
-
23
- * ``pycrypto`` - to use ``gntplib.ciphers`` module for message encryption
24
- * ``tornado`` - to use ``gntplib.async`` module for asynchronous processing
25
-
26
- Documentation
27
- -------------
28
-
29
- Release version: http://packages.python.org/gntplib/ (`ja
30
- <http://packages.python.org/gntplib/ja/>`_)
31
-
32
- Development version: http://gntplib.readthedocs.org/en/latest/
33
-
34
- History
35
- -------
36
-
37
- 0.5 (2012-04-13)
38
- ~~~~~~~~~~~~~~~~
39
-
40
- * Support ``SUBSCRIBE`` request.
41
-
42
- - Add ``gntplib.subscribe()``, ``gntplib.Subscriber`` and
43
- ``gntplib.async.AsyncSubscriber``.
44
-
45
- * Support Custom Headers and App-Specific Headers.
46
-
47
- * Deprecate ``gntplib.notify()``, ``gntplib.Notifier()`` and
48
- ``gntplib.AsyncNotifier()`` in favor of ``gntplib.publish()``,
49
- ``gntplib.Publisher()`` and ``gntplib.async.AsyncPublisher()``.
50
-
51
- * Deprecate ``gntplib.RawIcon`` and ``gntplib.async.AsyncIcon`` in favor of
52
- ``gntplib.Resource`` and ``gntplib.async.AsyncResource``.
53
-
54
- 0.4 (2012-04-07)
55
- ~~~~~~~~~~~~~~~~
56
-
57
- * Support password and encryption
58
- * Support Growl for Windows
59
-
60
- 0.3 (2012-03-30)
61
- ~~~~~~~~~~~~~~~~
62
-
63
- * Support Python 3
64
-
65
- 0.2 (2012-03-18)
66
- ~~~~~~~~~~~~~~~~
67
-
68
- * Add support for asynchronous processing built on Tornado.
69
-
70
- - Add ``gntplib.async.AsyncNotifier`` and ``gntplib.async.AsyncIcon``.
71
-
72
- * Imporve usability of callback.
73
-
74
- - ``SocketCallback``: Now ``SocketCallback`` is not a abstract class, but
75
- represents a socket callback. Its ``if_clicked``, ``if_closed`` and
76
- ``if_timedout`` methods are replaced with ``on_click``, ``on_close`` and
77
- ``on_timeout`` methods respectively, which can be set at the constructor.
78
-
79
- - ``Notifier.notify()``: Redefine ``callback`` argument as for the callback
80
- to run after closing the connection with the GNTP server.
81
- Add ``gntp_callback`` argument for url callback (as string) and socket
82
- callback (as ``SocketCallback`` instance).
83
- Add ``context``, ``context_type``, ``on_click``, ``on_close`` and
84
- ``on_timeout`` arguments to define a socket callback easily.
85
-
86
- * Remove ``callback`` argument from ``gntplib.notify()``.
87
-
88
- * Rename ``gntplib.Icon`` to ``gntplib.RawIcon``.
89
-
90
- 0.1 (2012-03-12)
91
- ~~~~~~~~~~~~~~~~
92
-
93
- * Initial release.
1
+ gntplib
2
+ =======
3
+
4
+ gntplib is a Growl Notification Transport Protocol (GNTP_) client library in
5
+ Python.
6
+
7
+ gntplib is tested on Python 2.7/3.2, Growl_ 1.3.3 and
8
+ `Growl for Windows`_ 2.0.9.
9
+
10
+ .. _GNTP: http://www.growlforwindows.com/gfw/help/gntp.aspx
11
+ .. _Growl: http://growl.info/
12
+ .. _Growl for Windows: http://www.growlforwindows.com/
13
+
14
+ Installation
15
+ ------------
16
+
17
+ Simply use pip::
18
+
19
+ $ pip install gntplib
20
+
21
+ There are the following **optional** prerequisites.
22
+
23
+ * ``pycrypto`` - to use ``gntplib.ciphers`` module for message encryption
24
+ * ``tornado`` - to use ``gntplib.async`` module for asynchronous processing
25
+
26
+ Documentation
27
+ -------------
28
+
29
+ Release version: http://packages.python.org/gntplib/ (`ja
30
+ <http://packages.python.org/gntplib/ja/>`_)
31
+
32
+ Development version: http://gntplib.readthedocs.org/en/latest/
33
+
34
+ History
35
+ -------
36
+
37
+ 0.5 (2012-04-13)
38
+ ~~~~~~~~~~~~~~~~
39
+
40
+ * Support ``SUBSCRIBE`` request.
41
+
42
+ - Add ``gntplib.subscribe()``, ``gntplib.Subscriber`` and
43
+ ``gntplib.async.AsyncSubscriber``.
44
+
45
+ * Support Custom Headers and App-Specific Headers.
46
+
47
+ * Deprecate ``gntplib.notify()``, ``gntplib.Notifier()`` and
48
+ ``gntplib.AsyncNotifier()`` in favor of ``gntplib.publish()``,
49
+ ``gntplib.Publisher()`` and ``gntplib.async.AsyncPublisher()``.
50
+
51
+ * Deprecate ``gntplib.RawIcon`` and ``gntplib.async.AsyncIcon`` in favor of
52
+ ``gntplib.Resource`` and ``gntplib.async.AsyncResource``.
53
+
54
+ 0.4 (2012-04-07)
55
+ ~~~~~~~~~~~~~~~~
56
+
57
+ * Support password and encryption
58
+ * Support Growl for Windows
59
+
60
+ 0.3 (2012-03-30)
61
+ ~~~~~~~~~~~~~~~~
62
+
63
+ * Support Python 3
64
+
65
+ 0.2 (2012-03-18)
66
+ ~~~~~~~~~~~~~~~~
67
+
68
+ * Add support for asynchronous processing built on Tornado.
69
+
70
+ - Add ``gntplib.async.AsyncNotifier`` and ``gntplib.async.AsyncIcon``.
71
+
72
+ * Imporve usability of callback.
73
+
74
+ - ``SocketCallback``: Now ``SocketCallback`` is not a abstract class, but
75
+ represents a socket callback. Its ``if_clicked``, ``if_closed`` and
76
+ ``if_timedout`` methods are replaced with ``on_click``, ``on_close`` and
77
+ ``on_timeout`` methods respectively, which can be set at the constructor.
78
+
79
+ - ``Notifier.notify()``: Redefine ``callback`` argument as for the callback
80
+ to run after closing the connection with the GNTP server.
81
+ Add ``gntp_callback`` argument for url callback (as string) and socket
82
+ callback (as ``SocketCallback`` instance).
83
+ Add ``context``, ``context_type``, ``on_click``, ``on_close`` and
84
+ ``on_timeout`` arguments to define a socket callback easily.
85
+
86
+ * Remove ``callback`` argument from ``gntplib.notify()``.
87
+
88
+ * Rename ``gntplib.Icon`` to ``gntplib.RawIcon``.
89
+
90
+ 0.1 (2012-03-12)
91
+ ~~~~~~~~~~~~~~~~
92
+
93
+ * Initial release.
@@ -0,0 +1 @@
1
+ version = "0.66"
@@ -1,153 +1,153 @@
1
- # Makefile for Sphinx documentation
2
- #
3
-
4
- # You can set these variables from the command line.
5
- SPHINXOPTS =
6
- SPHINXBUILD = sphinx-build
7
- PAPER =
8
- BUILDDIR = _build
9
-
10
- # Internal variables.
11
- PAPEROPT_a4 = -D latex_paper_size=a4
12
- PAPEROPT_letter = -D latex_paper_size=letter
13
- ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14
- # the i18n builder cannot share the environment and doctrees with the others
15
- I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16
-
17
- .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18
-
19
- help:
20
- @echo "Please use \`make <target>' where <target> is one of"
21
- @echo " html to make standalone HTML files"
22
- @echo " dirhtml to make HTML files named index.html in directories"
23
- @echo " singlehtml to make a single large HTML file"
24
- @echo " pickle to make pickle files"
25
- @echo " json to make JSON files"
26
- @echo " htmlhelp to make HTML files and a HTML help project"
27
- @echo " qthelp to make HTML files and a qthelp project"
28
- @echo " devhelp to make HTML files and a Devhelp project"
29
- @echo " epub to make an epub"
30
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
32
- @echo " text to make text files"
33
- @echo " man to make manual pages"
34
- @echo " texinfo to make Texinfo files"
35
- @echo " info to make Texinfo files and run them through makeinfo"
36
- @echo " gettext to make PO message catalogs"
37
- @echo " changes to make an overview of all changed/added/deprecated items"
38
- @echo " linkcheck to check all external links for integrity"
39
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
40
-
41
- clean:
42
- -rm -rf $(BUILDDIR)/*
43
-
44
- html:
45
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46
- @echo
47
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48
-
49
- dirhtml:
50
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51
- @echo
52
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53
-
54
- singlehtml:
55
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56
- @echo
57
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58
-
59
- pickle:
60
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61
- @echo
62
- @echo "Build finished; now you can process the pickle files."
63
-
64
- json:
65
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66
- @echo
67
- @echo "Build finished; now you can process the JSON files."
68
-
69
- htmlhelp:
70
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71
- @echo
72
- @echo "Build finished; now you can run HTML Help Workshop with the" \
73
- ".hhp project file in $(BUILDDIR)/htmlhelp."
74
-
75
- qthelp:
76
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77
- @echo
78
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
79
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gntplib.qhcp"
81
- @echo "To view the help file:"
82
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gntplib.qhc"
83
-
84
- devhelp:
85
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86
- @echo
87
- @echo "Build finished."
88
- @echo "To view the help file:"
89
- @echo "# mkdir -p $$HOME/.local/share/devhelp/gntplib"
90
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gntplib"
91
- @echo "# devhelp"
92
-
93
- epub:
94
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95
- @echo
96
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97
-
98
- latex:
99
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100
- @echo
101
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
103
- "(use \`make latexpdf' here to do that automatically)."
104
-
105
- latexpdf:
106
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107
- @echo "Running LaTeX files through pdflatex..."
108
- $(MAKE) -C $(BUILDDIR)/latex all-pdf
109
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110
-
111
- text:
112
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113
- @echo
114
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
115
-
116
- man:
117
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118
- @echo
119
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120
-
121
- texinfo:
122
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123
- @echo
124
- @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125
- @echo "Run \`make' in that directory to run these through makeinfo" \
126
- "(use \`make info' here to do that automatically)."
127
-
128
- info:
129
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130
- @echo "Running Texinfo files through makeinfo..."
131
- make -C $(BUILDDIR)/texinfo info
132
- @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133
-
134
- gettext:
135
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136
- @echo
137
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138
-
139
- changes:
140
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141
- @echo
142
- @echo "The overview file is in $(BUILDDIR)/changes."
143
-
144
- linkcheck:
145
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146
- @echo
147
- @echo "Link check complete; look for any errors in the above output " \
148
- "or in $(BUILDDIR)/linkcheck/output.txt."
149
-
150
- doctest:
151
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152
- @echo "Testing of doctests in the sources finished, look at the " \
153
- "results in $(BUILDDIR)/doctest/output.txt."
1
+ # Makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ PAPER =
8
+ BUILDDIR = _build
9
+
10
+ # Internal variables.
11
+ PAPEROPT_a4 = -D latex_paper_size=a4
12
+ PAPEROPT_letter = -D latex_paper_size=letter
13
+ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14
+ # the i18n builder cannot share the environment and doctrees with the others
15
+ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16
+
17
+ .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18
+
19
+ help:
20
+ @echo "Please use \`make <target>' where <target> is one of"
21
+ @echo " html to make standalone HTML files"
22
+ @echo " dirhtml to make HTML files named index.html in directories"
23
+ @echo " singlehtml to make a single large HTML file"
24
+ @echo " pickle to make pickle files"
25
+ @echo " json to make JSON files"
26
+ @echo " htmlhelp to make HTML files and a HTML help project"
27
+ @echo " qthelp to make HTML files and a qthelp project"
28
+ @echo " devhelp to make HTML files and a Devhelp project"
29
+ @echo " epub to make an epub"
30
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
32
+ @echo " text to make text files"
33
+ @echo " man to make manual pages"
34
+ @echo " texinfo to make Texinfo files"
35
+ @echo " info to make Texinfo files and run them through makeinfo"
36
+ @echo " gettext to make PO message catalogs"
37
+ @echo " changes to make an overview of all changed/added/deprecated items"
38
+ @echo " linkcheck to check all external links for integrity"
39
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
40
+
41
+ clean:
42
+ -rm -rf $(BUILDDIR)/*
43
+
44
+ html:
45
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46
+ @echo
47
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48
+
49
+ dirhtml:
50
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51
+ @echo
52
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53
+
54
+ singlehtml:
55
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56
+ @echo
57
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58
+
59
+ pickle:
60
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61
+ @echo
62
+ @echo "Build finished; now you can process the pickle files."
63
+
64
+ json:
65
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66
+ @echo
67
+ @echo "Build finished; now you can process the JSON files."
68
+
69
+ htmlhelp:
70
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71
+ @echo
72
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
73
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
74
+
75
+ qthelp:
76
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77
+ @echo
78
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
79
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gntplib.qhcp"
81
+ @echo "To view the help file:"
82
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gntplib.qhc"
83
+
84
+ devhelp:
85
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86
+ @echo
87
+ @echo "Build finished."
88
+ @echo "To view the help file:"
89
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/gntplib"
90
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gntplib"
91
+ @echo "# devhelp"
92
+
93
+ epub:
94
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95
+ @echo
96
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97
+
98
+ latex:
99
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100
+ @echo
101
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
103
+ "(use \`make latexpdf' here to do that automatically)."
104
+
105
+ latexpdf:
106
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107
+ @echo "Running LaTeX files through pdflatex..."
108
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
109
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110
+
111
+ text:
112
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113
+ @echo
114
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
115
+
116
+ man:
117
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118
+ @echo
119
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120
+
121
+ texinfo:
122
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123
+ @echo
124
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125
+ @echo "Run \`make' in that directory to run these through makeinfo" \
126
+ "(use \`make info' here to do that automatically)."
127
+
128
+ info:
129
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130
+ @echo "Running Texinfo files through makeinfo..."
131
+ make -C $(BUILDDIR)/texinfo info
132
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133
+
134
+ gettext:
135
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136
+ @echo
137
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138
+
139
+ changes:
140
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141
+ @echo
142
+ @echo "The overview file is in $(BUILDDIR)/changes."
143
+
144
+ linkcheck:
145
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146
+ @echo
147
+ @echo "Link check complete; look for any errors in the above output " \
148
+ "or in $(BUILDDIR)/linkcheck/output.txt."
149
+
150
+ doctest:
151
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152
+ @echo "Testing of doctests in the sources finished, look at the " \
153
+ "results in $(BUILDDIR)/doctest/output.txt."