1
0
mirror of synced 2026-04-02 12:59:32 +00:00

Docs: Show todos in previews

That includes local builds.
Also fix release version numbers.
This commit is contained in:
Krystine Sherwin
2024-08-29 10:43:01 +12:00
parent 25623b1010
commit 558f313a78

View File

@@ -61,15 +61,24 @@ if os.getenv("READTHEDOCS"):
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 1
# include todos for previews
extensions.append('sphinx.ext.todo')
# set version
if os.getenv("READTHEDOCS"):
rtds_version = os.getenv("READTHEDOCS_VERSION")
if rtds_version == "latest":
release = yosys_ver + "-dev"
todo_include_todos = False
elif rtds_version.startswith("yosys-"):
release = yosys_ver
todo_include_todos = False
else:
release = rtds_version
todo_include_todos = True
else:
release = yosys_ver
todo_include_todos = True
# assign figure numbers
numfig = True
@@ -84,10 +93,6 @@ latex_elements = {
'''
}
# include todos during rewrite
extensions.append('sphinx.ext.todo')
todo_include_todos = False
# custom cmd-ref parsing/linking
sys.path += [os.path.dirname(__file__) + "/../"]
extensions.append('util.cmdref')