Brad Warren
ceea41c1e2
Do not document private members ( #7675 )
...
It looks like we're currently documenting functions that are marked private (prefixed with an underscore) such as https://certbot.eff.org/docs/api/certbot.crypto_util.html#certbot.crypto_util._load_cert_or_req . I do not think we should do this because the functionality is private, should not be used, and including it in our docs just adds visual noise.
This PR stops us from documenting private code and fixes up `tools/sphinx-quickstart.sh` so we don't document it in future modules.
* Do not document private code.
* Don't document private members in the future.
2020-01-10 16:48:01 -08:00
Adrien Ferrand
e048da1e38
Reorganize imports ( #7616 )
...
* Isort execution
* Fix pylint, adapt coverage
* New isort
* Fix magic_typing lint
* Second round
* Fix pylint
* Third round. Store isort configuration
* Fix latest mistakes
* Other fixes
* Add newline
* Fix lint errors
2019-12-09 15:50:20 -05:00
Jannis Leidel
2abc94661a
Use josepy instead of acme.jose. ( #5203 )
2017-12-11 11:25:09 -08: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
Jakub Warmuz
d0a2b38457
pep8 for docs/conf.py
2015-11-07 19:36:08 +00: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
dfdb64c505
sphinx: default_role py:obj
2015-10-21 17:06:36 -07:00
Jakub Warmuz
1f0cbda9fc
Unify autodoc options
2015-10-21 17:06:36 -07:00
Jakub Warmuz
1a6fc9ce76
RTD theme everywhere!
2015-10-21 17:06:36 -07:00
Jakub Warmuz
607ea59fd3
Add extensions for subpkgs docs
2015-10-21 17:06:35 -07:00
Jakub Warmuz
635008f5e6
Configure intersphinx
2015-10-21 17:06:35 -07:00
Jakub Warmuz
b9868d3c97
sphinx-quickstart for subpkgs
...
```
sphinx-quickstart --dot _ --project acme-python --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile acme/docs
sphinx-quickstart --dot _ --project letsencrypt-apache --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-apache/docs
sphinx-quickstart --dot _ --project letsencrypt-nginx --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-nginx/docs
sphinx-quickstart --dot _ --project letshelp-letsencrypt --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letshelp-letsencrypt/docs
sphinx-quickstart --dot _ --project letsencrypt-compatibility-test --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-compatibility-test/docs
```
2015-10-21 17:06:35 -07:00
