Skip to content

doc: update to sync with microceph adoption of sphinx-starter-pack #839

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

Merged
roosterfish merged 2 commits into from
Jun 30, 2025
Merged

doc: update to sync with microceph adoption of sphinx-starter-pack #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e0f050
doc: add vlatest to custom wordlist
Jun 27, 2025
fed35f2
doc: update integration to sync with microceph update to sphinx-start…
Jun 27, 2025
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
1 change: 1 addition & 0 deletions doc/.custom_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ SVG
TinyPNG
uplink
VLAN
vlatest
VM
VMs
VPC
Expand Down
18 changes: 13 additions & 5 deletions doc/.sphinx/_integration/add_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,23 @@
html_context['microovn_path'] = "../microovn"
html_context['microovn_tag'] = "../microovn/_static/microovn.png"

# Add the search JavaScript file
custom_html_js_files.append('rtd-search.js')

if project == "LXD":
html_baseurl = "https://documentation.ubuntu.com/lxd/latest/"
custom_html_js_files.append('rtd-search.js')
custom_tags.append('integrated')
elif project == "MicroCeph":
html_baseurl = "https://canonical-microceph.readthedocs-hosted.com/en/latest/"
# Override default header templates
templates_path = globals().get('templates_path', []) + [".sphinx/_templates"]
# Override default header styles
html_static_path = globals().get('html_static_path', []) + [".sphinx/_static"]
html_css_files = globals().get('html_css_files', []) + ['override-header.css']
# Add rtd-search.js to the list of JS files
html_js_files = globals().get('html_js_files', []) + ['rtd-search.js']
# Add "integrated" to the list of custom tags
custom_tags = globals().get('custom_tags', []) + ['integrated']
elif project == "MicroOVN":
html_baseurl = "https://canonical-microovn.readthedocs-hosted.com/en/latest/"
custom_html_js_files.append('rtd-search.js')
custom_tags.append('integrated')

# Include integrated tag
custom_tags.append('integrated')
20 changes: 20 additions & 0 deletions doc/.sphinx/_integration/override-header.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/* This CSS file overrides the default header.css injected by the canonical-sphinx
theme extension used by docs sets that use the sphinx-starter-pack.
*/

body ul.p-navigation__links {
max-width: none;
}

body ul.p-navigation__links li {
padding-left: 20px;
}

ul.p-navigation__links li.active {
background-color: #E95420;
}

body ul.p-navigation__links li a:hover,
body ul.p-navigation__links li a:visited:hover {
text-decoration: none;
}
7 changes: 4 additions & 3 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,14 @@ integrate:
git -C integration/microovn reset --hard $(MICROOVNVERSION)
# Create a directory for files to override in MicroCloud docs
mkdir -p integration/microcloud/_templates/ integration/microcloud/_static
# Copy the header HTML and CSS files for the doc sets
mkdir -p integration/microceph/docs/.sphinx/_templates integration/microceph/docs/.sphinx/_static
# Copy the header HTML and CSS files for the doc sets
cp .sphinx/_integration/microcloud.html integration/microcloud/_templates/header.html
cp .sphinx/_integration/header.css integration/microcloud/_static/
cp .sphinx/_integration/lxd.html integration/lxd/doc/.sphinx/_templates/header.html
cp .sphinx/_integration/header.css integration/lxd/doc/.sphinx/_static/
cp .sphinx/_integration/microceph.html integration/microceph/docs/.sphinx/_templates/header.html
cp .sphinx/_integration/header.css integration/microceph/docs/.sphinx/_static/
cp .sphinx/_integration/override-header.css integration/microceph/docs/.sphinx/_static/
cp .sphinx/_integration/microovn.html integration/microovn/docs/.sphinx/_templates/header.html
cp .sphinx/_integration/header.css integration/microovn/docs/.sphinx/_static/
# Copy the search JavaScript file
Expand All @@ -62,7 +63,7 @@ integrate:
cp .sphinx/_integration/rtd-search.js integration/microovn/docs/.sphinx/_static/
# Add information about where to find the tags/docs to the doc sets
cat .sphinx/_integration/add_config.py >> integration/lxd/doc/custom_conf.py
cat .sphinx/_integration/add_config.py >> integration/microceph/docs/custom_conf.py
cat .sphinx/_integration/add_config.py >> integration/microceph/docs/conf.py
cat .sphinx/_integration/add_config.py >> integration/microovn/docs/custom_conf.py
# Override the MicroOVN tag with the circle of friends one (for consistency)
cp .sphinx/_integration/tag.png integration/microovn/docs/.sphinx/_static/microovn.png
Expand Down