doc: update conf.py and add js for URL migration (v2-edge)#1398
Draft
elijahgreenstein wants to merge 3 commits into
Draft
doc: update conf.py and add js for URL migration (v2-edge)#1398elijahgreenstein wants to merge 3 commits into
elijahgreenstein wants to merge 3 commits into
Conversation
elijahgreenstein
changed the title
roosterfish
previously approved these changes
Jun 3, 2026
roosterfish
left a comment
roosterfish
left a comment
Contributor
There was a problem hiding this comment.
LGTM, ready when you give the green light :)
elijahgreenstein
force-pushed
the
migrate-v2-edge
branch
6 times, most recently
from
1a08487 to
a27d513
Compare
elijahgreenstein
force-pushed
the
migrate-v2-edge
branch
from
a27d513 to
0f5c0e3
Compare
elijahgreenstein
force-pushed
the
migrate-v2-edge
branch
5 times, most recently
from
50b93db to
740465e
Compare
These changes support migration of the documentation from documentation.ubuntu.com/microcloud to canonical.com/microcloud/docs: - Adds `doc/_static/js/overwrite_links.js` to properly handle links in the flyout menu (version selector). - Updates configuration settings in `doc/conf.py` - Reorganizes JavaScript files into `doc/_static/js` directory, and updates relevant paths Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com> (cherry picked from commit c155dbd)
This commit removes the "Contribute to this page" button. This change is temporary, and the button will be restored after the docs have moved to canonical.com. Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com> (cherry picked from commit e599f5a)
- Copies the MicroCloud `overwrite_links.js` file into the cloned LXD, MicroCeph, and MicroOVN repos as `overwrite_microcloud_links.js`, so that the JavaScript loads across the integrated docs - Prefixes functions and variables in the MicroCloud `overwrite_links.js` file with `microcloud_` in order to prevent conflicts with the equivalents in the LXD, MicroCeph, and MicroOVN `overwrite_links.js` files. - Reconfigures the Makefile to append `add_config.py` to the end of the MicroOVN `conf.py` so that the addition of `overwrite_microcloud_links.js` to `html_js_files` applies to MicroOVN. Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com> (cherry picked from commit c19f795)
elijahgreenstein
force-pushed
the
migrate-v2-edge
branch
from
740465e to
adac6da
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These changes support migration of the documentation from documentation.ubuntu.com/microcloud to canonical.com/microcloud/docs:
doc/_static/js/overwrite_links.jsto properly handle links in the flyout menu (version selector).doc/conf.pydoc/_static/jsdirectory, and updates relevant paths(cherry picked from commit 52587cb)
Checklist