Skip to content

Commit

Permalink
doc: add man1 to reference setup
Browse files Browse the repository at this point in the history
Problem: The links to flux-core's man1 pages do not work properly
because the setup() function does not add man1 pages as a role during
setup.

Add man1 as a section during setup.
  • Loading branch information
cmoussa1 committed Oct 10, 2024
1 parent 3fc0225 commit e856d39
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@
extensions = ["sphinx.ext.intersphinx", "sphinx.ext.napoleon", "domainrefs"]

domainrefs = {
"core:man1": {
"text": "%s(1)",
"url": "https://flux-framework.readthedocs.io/projects/flux-core/en/latest/man1/%s.html",
},
"core:man5": {
"text": "%s(5)",
"url": "https://flux-framework.readthedocs.io/projects/flux-core/en/latest/man5/%s.html",
Expand Down Expand Up @@ -118,7 +122,7 @@ def man_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
# launch setup
def setup(app):
app.connect("builder-inited", run_apidoc)
for section in [5]:
for section in [1, 5]:
app.add_role(f"man{section}", man_role)


Expand Down

0 comments on commit e856d39

Please sign in to comment.