IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: hide todo admonitions on RTD (#12442)

Browse Source 
`todo` admonitions should not be present in the user-facing documentation (built on ReadTheDocs)
This commit is contained in:
Chris Sewell 2024-06-19 15:15:31 +02:00 committed by GitHub
parent 37ff33dff7
commit 13b16c9b04
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/conf.py
View File

@ -115,7 +115,7 @@ linkcheck_anchors_ignore_for_url = [
autodoc_member_order = 'groupwise' autodoc_member_order = 'groupwise'
autosummary_generate = False autosummary_generate = False
todo_include_todos = True todo_include_todos = 'READTHEDOCS' not in os.environ
extlinks = { extlinks = {
'dupage': ('https://docutils.sourceforge.io/docs/ref/rst/%s.html', '%s'), 'dupage': ('https://docutils.sourceforge.io/docs/ref/rst/%s.html', '%s'),
'duref': ( 'duref': (

1
tox.ini
View File

@ -18,6 +18,7 @@ passenv =
TERM TERM
CLEAN CLEAN
BUILDER BUILDER
READTHEDOCS
description = description =
py{39,310,311,312,313}: Run unit tests against {envname}. py{39,310,311,312,313}: Run unit tests against {envname}.
extras = extras =