Skip to content

Commit f77a6f6

Browse files
authored
doc: update microovn url, microceph variable (#1442)
- Updates MicroOVN docs URL following the move to ubuntu.com/docs/microovn. - Updates the MicroCeph build directory variable after `BUILDDIR` was changed to `DOCS_BUILDDIR` in canonical/microceph#794. ## Checklist - [x] I have read the [contributing guidelines](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md) and attest that all commits in this PR are [signed off](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#including-a-signed-off-by-line-in-your-commits), [cryptographically signed](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#commit-signature-verification), and follow this project's [commit structure](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#commit-structure). - [x] I have checked and added or updated relevant documentation.
2 parents 8b22013 + b91817d commit f77a6f6

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

doc/.sphinx/_integration/add_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@
2323
# Add "integrated" to the list of custom tags
2424
tags.add('integrated')
2525
elif project == "MicroOVN":
26-
html_baseurl = "https://canonical-microovn.readthedocs-hosted.com/en/latest/"
26+
html_baseurl = "https://ubuntu.com/docs/microovn/latest/"
2727
custom_tags.append('integrated')
2828

doc/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,15 +118,15 @@ integrate:
118118
html: integrate install
119119
mkdir -p $(current_dir)/_build
120120
cd integration/lxd/doc/ && $(MAKE) html BUILDDIR=$(current_dir)/_build/lxd
121-
cd integration/microceph/docs/ && $(MAKE) html BUILDDIR=$(current_dir)/_build/microceph
121+
cd integration/microceph/docs/ && $(MAKE) html DOCS_BUILDDIR=$(current_dir)/_build/microceph
122122
cd integration/microovn/docs/ && $(MAKE) html BUILDDIR=$(current_dir)/_build/microovn
123123
. $(DOCS_VENV); $(SPHINX_BUILD) -W --keep-going -b dirhtml "$(DOCS_SOURCEDIR)" "$(current_dir)/_build" -w $(SPHINX_DIR)/warnings.txt $(SPHINX_OPTS)
124124

125125
# `html-rtd` builds the integrated docs, with the correct paths for Read the Docs.
126126
# This target is used by the Read the Docs build.
127127
html-rtd: install
128128
PATH_PREFIX=$(PATH_PREFIX) $(MAKE) -C integration/lxd/doc/ html-rtd BUILDDIR=$(READTHEDOCS_OUTPUT)/html/lxd
129-
PATH_PREFIX=$(PATH_PREFIX) $(MAKE) -C integration/microceph/docs/ html BUILDDIR=$(READTHEDOCS_OUTPUT)/html/microceph
129+
PATH_PREFIX=$(PATH_PREFIX) $(MAKE) -C integration/microceph/docs/ html DOCS_BUILDDIR=$(READTHEDOCS_OUTPUT)/html/microceph
130130
PATH_PREFIX=$(PATH_PREFIX) $(MAKE) -C integration/microovn/docs/ html BUILDDIR=$(READTHEDOCS_OUTPUT)/html/microovn
131131
. $(DOCS_VENV); PATH_PREFIX=$(PATH_PREFIX) $(SPHINX_BUILD) -W --keep-going -b dirhtml "$(DOCS_SOURCEDIR)" "$(READTHEDOCS_OUTPUT)/html" -w $(SPHINX_DIR)/warnings.txt $(SPHINX_OPTS)
132132

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@
267267
intersphinx_mapping = {
268268
'lxd': ('https://canonical.com/lxd/docs/latest/', None),
269269
'microceph': ('https://documentation.ubuntu.com/canonical-microceph/latest/', None),
270-
'microovn': ('https://canonical-microovn.readthedocs-hosted.com/en/latest/', None),
270+
'microovn': ('https://ubuntu.com/docs/microovn/latest/', None),
271271
}
272272
elif ('READTHEDOCS' in os.environ) and (os.environ['READTHEDOCS'] == 'True'):
273273
intersphinx_mapping = {

0 commit comments

Comments
 (0)