diff options
| author | Brad Warren <bmw@users.noreply.github.com> | 2020-02-07 02:39:47 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-07 02:39:47 +0300 |
| commit | 1859fb059d598021703a79a50f60393ed8887759 (patch) | |
| tree | 61addc0ed6e83c49421d72e617d06eb839d1f186 /certbot-dns-luadns/docs/conf.py | |
| parent | c5a2ba03da7c027bad7288631a8425dc89587db5 (diff) | |
Don't display todo comments in docs (#7753)
Currently if you go to https://certbot.eff.org/docs/api/certbot.crypto_util.html, there is a todo comment displayed at the top of the page. These todos were written for developers, not users, so I do not think they should be shown from our documentation.
This PR makes the quick and easy fix of configuring Sphinx not to show these todo items. I created #7752 to track removing all of these todos from our docstrings and disabling the Sphinx todo extension.
* Set todo_include_todos=False in sphinx-quickstart
* Remove todos from existing docs.
Diffstat (limited to 'certbot-dns-luadns/docs/conf.py')
| -rw-r--r-- | certbot-dns-luadns/docs/conf.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/certbot-dns-luadns/docs/conf.py b/certbot-dns-luadns/docs/conf.py index 8e9d49988..ed318619d 100644 --- a/certbot-dns-luadns/docs/conf.py +++ b/certbot-dns-luadns/docs/conf.py @@ -84,7 +84,7 @@ default_role = 'py:obj' pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True +todo_include_todos = False # -- Options for HTML output ---------------------------------------------- |