Skip to content

Commit

Permalink
doc: decode the objects.inv file
Browse files Browse the repository at this point in the history
Sphinx creates an objects.inv file that contains a mapping of IDs and
locations in the docs. The UI needs this mapping to be able to resolve
links within the descriptions of config options.

The UI would require additional dependencies to decode the objects.inv
file, so providing the decoded version with the documentation is
easier.

Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
  • Loading branch information
ru-fu committed Jan 5, 2024
1 parent e676fc6 commit 1362a54
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,17 @@ doc-setup: client
rm -Rf doc/.sphinx/.doctrees

.PHONY: doc
doc: doc-setup doc-incremental
doc: doc-setup doc-incremental doc-objects

.PHONY: doc-incremental
doc-incremental:
@echo "Build the documentation"
. $(SPHINXENV) ; LOCAL_SPHINX_BUILD=True sphinx-build -c doc/ -b dirhtml doc/ doc/html/ -d doc/.sphinx/.doctrees -w doc/.sphinx/warnings.txt

.PHONY: doc-objects
doc-objects:
. $(SPHINXENV); cd doc/html; python3 -m sphinx.ext.intersphinx 'objects.inv' > objects.inv.txt

.PHONY: doc-serve
doc-serve:
cd doc/html; python3 -m http.server 8001
Expand Down

0 comments on commit 1362a54

Please sign in to comment.