Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add global_substitutions to fix github links #85

Merged
merged 5 commits into from
May 12, 2023
Merged

Add global_substitutions to fix github links #85

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bcd164f
Add global_substitutions to fix github links
christophfroehlich May 10, 2023
c34e601
Revert unnecessary changes
christophfroehlich May 10, 2023
f55dbcf
Update requirements
christophfroehlich May 10, 2023
c62a899
Fix format
christophfroehlich May 10, 2023
218cd92
Merge branch 'master' into global_substition
christophfroehlich May 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
"sphinx.ext.ifconfig",
"sphinx_copybutton",
"sphinx.ext.viewcode",
"sphinxcontrib.globalsubs"
]

# If true, `todo` and `todoList` produce output, else they produce nothing.
Expand Down Expand Up @@ -318,9 +319,18 @@ def smv_rewrite_configs(app, config):
app.config.html_baseurl = app.config.html_baseurl + "/" + distro + "/"
app.config.project = "ROS2_Control: " + distro.title()
app.config.html_logo = "images/logo_ros-controls.png"

# see https://github.com/missinglinkelectronics/sphinxcontrib-globalsubs
app.config.global_substitutions = {
'github_branch': branch,
}
else:
# If we are not building a multiversion build, default to the rolling logo
app.config.html_logo = "images/logo_ros-controls.png"
# see https://github.com/missinglinkelectronics/sphinxcontrib-globalsubs
app.config.global_substitutions = {
'github_branch': 'master',
}


def github_link_rewrite_branch(app, pagename, templatename, context, doctree):
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ sphinx
sphinx-copybutton
sphinx-multiversion
sphinx_rtd_theme
sphinxcontrib-globalsubs