starred/certbot-certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-07-26 15:48:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

Do not document private members (#7675)

Browse Source 
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.
This commit is contained in:
Brad Warren
2020-01-10 16:48:01 -08:00
committed by GitHub
parent 456122e342
commit ceea41c1e2
18 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
certbot/docs/conf.py
+1 -1
View File
@@ -52,7 +52,7 @@ if sphinx.version_info >= (1, 6):
extensions.append('sphinx.ext.imgconverter')
autodoc_member_order = 'bysource'
autodoc_default_flags = ['show-inheritance', 'private-members']
autodoc_default_flags = ['show-inheritance']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']