diff options
| author | Brad Warren <bmw@users.noreply.github.com> | 2020-01-11 03:48:01 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-11 03:48:01 +0300 |
| commit | ceea41c1e2c03ea3d8c9976a6a3ff87f248cedd7 (patch) | |
| tree | fe5adc05998028ade9be0d2e15319818000f7d86 /certbot-dns-sakuracloud/docs/conf.py | |
| parent | 456122e342db13cda50b9ae59a1be9521b6547d8 (diff) | |
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.
Diffstat (limited to 'certbot-dns-sakuracloud/docs/conf.py')
| -rw-r--r-- | certbot-dns-sakuracloud/docs/conf.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/certbot-dns-sakuracloud/docs/conf.py b/certbot-dns-sakuracloud/docs/conf.py index f973779ab..70a4d7434 100644 --- a/certbot-dns-sakuracloud/docs/conf.py +++ b/certbot-dns-sakuracloud/docs/conf.py @@ -38,7 +38,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] 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'] |