sydneyli
f5aad1440f
Conditionally depend on imgconverter for newer versions of Sphinx ( #6536 )
...
Fixes #6343 .
* conditionally depend on imgconverter
* Pin docutils dependency for old Sphinx bug
2018-12-04 10:56:15 -08:00
Brad Warren
d8057f0e17
Fix Sphinx ( #6070 )
...
Fixes #4686 .
In Sphinx 1.6, they changed how they handle images in latex and PDF files. You can learn more about this by reading the linked issue (or I can answer any questions), but the shortish version is we now need to use the extension sphinx.ext.imgconverter. This is only available in Sphinx 1.6+.
I also updated our pinned versions to use the latest Sphinx and a new dependency it pulled in called sphinxcontrib-websupport. To build the latex and PDF docs, you must first run:
apt-get install imagemagick latexmk texlive texlive-latex-extra
Afterwards, if you create the normal Certbot dev environment using this branch, activate the virtual environment, and from the root of the repo run make -C docs clean latex latexpdf, you'll successfully build the PDF docs.
* fix #4686
* bump minimum Sphinx req
2018-08-06 09:45:56 -07:00
Noah Swartz
c0068791ce
add let's encrypt status to footer and fix link
2018-01-24 13:56:40 -08:00
Andrew Ittner
ed23290232
Clean up Sphinx errors ( #4706 )
...
Also minor copyedits, suppress unhelpful errors, mark files that should
*not* be in the TOC as hidden.
2017-05-26 20:57:14 -07:00
Peter Eckersley
0956e61c7c
Remove the sphinxcontrib.programout [docs]dependency ( #3830 )
...
- By making a static text file at release time, and including that
instead.
2016-11-30 10:47:10 -08:00
Noah Swartz
f53f4dd491
fix docs copyright
2016-05-12 09:30:45 -07:00
Noah Swartz
9ddabc3e9a
fix docs conf
2016-05-09 15:17:14 -07:00
Brad Warren
39763bc69f
Stray Let's Encrypt
2016-04-14 13:45:36 -07:00
Brad Warren
6daa2dd042
Doc checkup
2016-04-14 13:44:12 -07:00
Brad Warren
d4222ea6b6
Remove renewer docs
2016-02-03 14:54:45 -08:00
Jakub Warmuz
d0a2b38457
pep8 for docs/conf.py
2015-11-07 19:36:08 +00:00
Christoph Kisfeld
f8da08e6a2
Fix readthedocs Intersphinx URLs, fix #1140
2015-10-28 11:37:24 +01:00
Harlan Lieberman-Berg
1964bdeb78
Correct minor syntax error in docs/conf.py.
2015-10-21 17:06:36 -07:00
Jakub Warmuz
f922b9b694
Split docs into subpkgs ( fixes #969 )
2015-10-21 17:06:36 -07:00
Jakub Warmuz
86f01d1fa9
sphinx: copyright 2014-2015
2015-10-21 17:06:36 -07:00
Jakub Warmuz
511eef130b
Unify todo_include_todos
2015-10-21 17:06:35 -07:00
Jakub Warmuz
635008f5e6
Configure intersphinx
2015-10-21 17:06:35 -07:00
Jakub Warmuz
1e18351041
Fix #903 : docs version parsing
2015-10-05 19:44:35 +00:00
Jakub Warmuz
2e90ecf1b0
Add basic manpages for all binaries ( fixes #700 ).
2015-08-22 14:12:16 +00:00
Jakub Warmuz
04c12a5e38
Update package references after subdirs rename for Vagrant and Docker.
2015-07-11 05:15:10 +00:00
Jakub Warmuz
ff8925d92f
Update sys.path in docs/conf.py for Sphinx to find subdir packages.
2015-07-10 17:22:52 +00:00
Jakub Warmuz
02e7154c0d
Drop M2Crypto
2015-07-06 12:18:27 +00:00
Jakub Warmuz
3206eb674a
rst cleanup: contributing, using
2015-03-22 22:25:50 +00:00
Jakub Warmuz
b6203d512c
acme.jose: (Typed)JSONObjectWithFields, Field, JWA.
2015-03-18 14:10:28 +00:00
Jakub Warmuz
ca2bbc13a3
Improve letsencrypt.acme docs.
2015-02-25 13:56:48 +00:00
Jakub Warmuz
a5551604c6
Reference docs augeas/M2Crypto hack to github bug
2015-02-24 16:55:25 +00:00
Jakub Warmuz
31f444e4ba
Mock augeas and M2Crypto in docs ( fixes #262 ).
2015-02-24 16:51:42 +00:00
Jakub Warmuz
edce44024b
Use sphinx_rtd_theme locally.
2015-02-24 16:23:54 +00:00
Thomas Waldmann
c42f512c2a
refactor conf.py, add comment about version syntax
2015-02-01 03:15:39 +01:00
Thomas Waldmann
44c2b38cde
use version from package init also for sphinx docs, insert toplevel dir into sys.path
2015-01-31 06:01:52 +01:00
Jakub Warmuz
1725829477
Autodoc interfaces. Spelling.
2015-01-31 00:28:09 +00:00
Jakub Warmuz
59a7559c05
Unify docs
2014-11-30 02:46:21 +01:00
Jakub Warmuz
af298b35a1
sphinx-quickstart
2014-11-30 02:38:33 +01:00
