doc: update conf.py and add js for URL migration - #1397
Merged
Conversation
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 :)
Contributor
|
Should we start with this one first, or do we have to merge all of them at around the same time as we switch "all" the docs from |
Contributor
Author
|
Once we get the go ahead, we should merge both of the MicroCloud updates around the same time, so that the entire MicroCloud doc set is moved to |
elijahgreenstein
force-pushed
the
migrate-main
branch
from
June 5, 2026 03:53
52587cb to
90d659b
Compare
elijahgreenstein
force-pushed
the
migrate-main
branch
from
June 25, 2026 19:50
7fe8fc2 to
c8ce384
Compare
elijahgreenstein
force-pushed
the
migrate-main
branch
10 times, most recently
from
July 7, 2026 22:41
eee83a6 to
c19f795
Compare
elijahgreenstein
force-pushed
the
migrate-main
branch
2 times, most recently
from
July 10, 2026 22:39
0840424 to
79ed613
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>
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>
- 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>
elijahgreenstein
force-pushed
the
migrate-main
branch
from
July 13, 2026 16:40
79ed613 to
fde8f1a
Compare
elijahgreenstein
marked this pull request as ready for review
July 14, 2026 01:08
Contributor
Author
|
@roosterfish -- this is ready to go now. |
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 pathsChecklist