Commit Graph

43 Commits (master)

Author SHA1 Message Date
Isis Lovecruft 5207ccc6b4
Update copyright years on Sphinx docs. 2014-08-02 01:54:30 +00:00
Isis Lovecruft cfff8aaba8
Fix blockquotes of previous documentation in gnupg.rst. 2013-12-03 22:00:09 +00:00
Isis Lovecruft 87b8c97a34
Fix a couple refs pointing to the wrong classes in docs/gnupg.rst. 2013-12-03 21:59:50 +00:00
Isis Lovecruft 9a4f9c2f9a
Don't document special attributes in _meta twice. 2013-12-03 21:56:59 +00:00
Isis Lovecruft 8dda32636f
Add reference Sphinx directives for module sections in docs. 2013-12-03 21:55:57 +00:00
Isis Lovecruft 15d5635ea4
Disable Sphinx prefixing with full module names. 2013-12-03 21:55:08 +00:00
Isis Lovecruft 91ef911862
Specify Sphinx source encoding explicitly. 2013-12-03 21:54:29 +00:00
Isis Lovecruft 0f611c3c13
Add intersphinx mapping to docs.python.org. 2013-12-03 21:53:54 +00:00
Isis Lovecruft 66c3a1b693
Update Sphinx version requirement. 2013-12-03 21:53:12 +00:00
Isis Lovecruft 638d639558
Add options to Sphinx conf.py for -Wall and rebuild environment. 2013-12-03 21:51:09 +00:00
Isis Lovecruft 7d7dec5d9f
Make doc html head font easier to read. 2013-12-03 21:49:46 +00:00
Isis Lovecruft 0e6171a4af
Move DETAILS.html into _static/ so that the documentation can link to it. 2013-12-03 21:47:39 +00:00
Isis Lovecruft 6cf7e0fe61
Revert "remove docs/_static folder."
This reverts commit e5351cfe95.

As mentioned on the issue tracker, [0] some of the CSS from docs/_static was
still required to make the layout of the Sphinx generated output have the
correct layout. I reverted the last commit, which removed the whole
docs/_static directory, and then removed all the JavaScript and the unneeded
CSS. Hopefully, this is okay with Debian. :)

[0]: https://github.com/isislovecruft/python-gnupg/pull/27#issuecomment-29712108
2013-12-03 21:42:46 +00:00
Isis Lovecruft e9b422ec58
Merge remote-tracking branch 'kalikaneko/bug/fix-sphinx-build' into develop 2013-12-03 13:52:23 +00:00
Isis Lovecruft 96c3ee97f9
Fix Sphinx build failing due to missing psutil import. 2013-12-03 10:54:13 +00:00
Kali Kaneko e5351cfe95 remove docs/_static folder.
It was giving troubles with debian dh_sphinxdoc, due
to an old, unrecognized version of jquery being there that
could not be symlinked to the js-sphinxdoc version.
2013-10-14 02:49:30 -03:00
Kali Kaneko a115eec9ff workaround for sphinx assertion error
We were hitting sphinx bug documented at
https://bitbucket.org/birkenfeld/sphinx/issue/1160

This workaround makes those assertion error dissapear and
sphinx to finish happily.
2013-10-14 01:24:10 -03:00
Isis Lovecruft 156bfb6514
Add documentation on turning a primary key into a subkey and vice versa. 2013-10-08 12:38:57 +00:00
Isis Lovecruft 7f74ab7df9
Add another OpenPGP in DNS doc 2013-09-30 06:28:31 +00:00
Isis Lovecruft 467cad9634
Add documentation on publishing OpenPGP records in DNS.
* Taken from Dan Mahoney's post at
   http://www.gushi.org/make-dns-cert/HOWTO.html

 * Re-markdown-ified with http://html2markdown.com/, the source of which lives
   here: https://github.com/domchristie/to-markdown
2013-08-30 11:42:38 +00:00
Isis Lovecruft b54cb8ee42
Update docs/index.rst to point to online text of new license. 2013-07-27 19:37:07 +00:00
Isis Lovecruft 6b154c294e
Change LICENSE to GPLv3+, after discussion with intrigeri.
* ADD docs/change-license-emails.txt, which includes email exchanges between
   myself and intrigeri, including links to Debian and LEAP mailing lists with
   arguments for and against using AGPL for a library.
 * CHANGE license header for all files.
 * CHANGE LICENSE file and gnupg/copyright.py to use GPLv3+ text.
2013-07-27 19:27:53 +00:00
Isis Lovecruft 1da138e75b
Update Sphinx templating and stylesheets. 2013-07-03 10:22:05 +00:00
Isis Lovecruft f8ab757b46
Add generated Emacs orgmode → html output for docs/NOTES…audit.org file. 2013-07-03 10:20:41 +00:00
Isis Lovecruft 1f717e167d
Add Emacs orgmode → html output for doc/DETAILS file. 2013-07-03 10:19:53 +00:00
Isis Lovecruft 5b30ebd5a9
Reorganise Sphinx documentation directives in the doc/*.rst files. 2013-07-03 10:18:57 +00:00
Isis Lovecruft c77a40b820
Change around a bunch of Sphinx settings. 2013-07-03 10:16:27 +00:00
Isis Lovecruft f7a5cb3953
Fix the source directory for Sphinx to load packages from. 2013-07-03 10:13:21 +00:00
Isis Lovecruft b9cef09c93
Remove epa-file-encrypt line from orgmode line. 2013-07-02 12:37:10 +00:00
Isis Lovecruft f450aeb9b0
Reorganise docs and update README. 2013-07-02 08:32:34 +00:00
Isis Lovecruft c683ef31c2
Move old documentation to Sphinx rest file at the end.
* It seems annoying to have a bunch of licensing and history lessons as the
   first thing you read when you look at the documentation. Rather, the first
   thing you see should be how to install it and use it.
2013-05-26 14:04:33 +00:00
Isis Lovecruft dfbba04bd7
Add note to TODO file about python ORMs for public key storage. 2013-05-25 23:04:45 +00:00
Isis Lovecruft 0462e8509c
Move TODO file to docs/ subfolder. 2013-05-14 11:10:45 +00:00
Isis Lovecruft 0c0f0c069a
Move LICENSE file to docs/ subfolder. 2013-05-14 11:08:18 +00:00
Isis Lovecruft b7d9f749b6
Decrypt docs/NOTES-python-openpgp-implementations. 2013-05-28 08:04:47 +00:00
Isis Lovecruft af5e67aa91
Add docs/DETAILS, from git://git.gnupg.org/gnupg.git branch 'STABLE-BRANCH-2-0' 2013-05-27 09:39:31 +00:00
Isis Lovecruft 5b0e8bc407
Add documentation for gnupg.parsers module. 2013-04-14 09:33:11 +00:00
Isis Lovecruft c99a8cb53e
Remove autoclassing gnupg.GPG twice in the documentation. 2013-04-14 09:31:31 +00:00
Isis Lovecruft a4b8c7823f
Update Sphinx config due to directory layout change. 2013-04-12 00:02:06 +00:00
Isis Lovecruft f01668fe48
Add NOTES file to docs/ directory. 2013-04-11 18:16:05 +00:00
Isis Lovecruft f9bd8e928e
Updated documentation and .rst files for Sphinx. 2013-04-06 00:35:40 +00:00
Isis Lovecruft 1ed011a0db
Update Sphinx documentation config for autodoc and for module path discovery. 2013-04-05 23:02:14 +00:00
Isis Lovecruft 86be391a56
Add documentation creator and first set of API docs.
* This uses Sphinx's command 'sphinx-apidoc'.
 * TODO Find a way to make Sphinx build the documentations without installing
   the module locally first.
2013-04-05 22:50:52 +00:00