summaryrefslogtreecommitdiff
path: root/docs/source/conf.py
diff options
context:
space:
mode:
authorErik Sjölund <erik.sjolund@gmail.com>2022-03-06 21:40:39 +0100
committerErik Sjölund <erik.sjolund@gmail.com>2022-03-06 21:40:39 +0100
commitf13ca392c67ee957efdf64f178c5ca05f5f6d8c7 (patch)
tree9207e528597972879006fbb8627694af1818f328 /docs/source/conf.py
parentf4d6e8777213880204ccbce92201c47c74b33036 (diff)
downloadpodman-f13ca392c67ee957efdf64f178c5ca05f5f6d8c7.tar.gz
podman-f13ca392c67ee957efdf64f178c5ca05f5f6d8c7.tar.bz2
podman-f13ca392c67ee957efdf64f178c5ca05f5f6d8c7.zip
[CI:DOCS] Remove "(1)" from web tab text
* Remove the ending text "(1)" to avoid it from being displayed in the web tab title for a command man page on the web. Often such a text indicates that a web page got an update. For instance GitHub issues shows the number of new comments that have been written after the user's last visit. Fixes #13438 Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
Diffstat (limited to 'docs/source/conf.py')
-rw-r--r--docs/source/conf.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 7684dd3f7..505bcbec7 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -72,8 +72,13 @@ def convert_markdown_title(app, docname, source):
docpath = app.env.doc2path(docname)
if docpath.endswith(".md"):
# Convert pandoc title line into eval_rst block for myst_parser
- source[0] = re.sub(r"^% (.*)", r"```{title} \g<1>\n```", source[0])
-
+ #
+ # Remove the ending "(1)" to avoid it from being displayed
+ # in the web tab. Often such a text indicates that
+ # a web page got an update. For instance GitHub issues
+ # shows the number of new comments that have been written
+ # after the user's last visit.
+ source[0] = re.sub(r"^% (.*)(\(\d\))", r"```{title} \g<1>\n```", source[0])
def setup(app):
app.connect("source-read", convert_markdown_title)