Open
Conversation
Add ubt_sphinx as dependency and configure the ubtrace Sphinx builder
so customers can build ubTrace-compatible output out of the box:
UBTRACE_VERSION=1.0 uv run sphinx-build -b ubtrace docs docs/_build/ubtrace
The build output can be imported directly into ubTrace via:
make import-build SRC=docs/_build/ubtrace/useblocks/x-as-code/1.0 \
ORG=useblocks PROJECT=x-as-code VERSION=1.0
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
1 participant
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.
Summary
ubt-sphinx>=0.4.0as a dependencyubt_sphinxextension inconf.pyubtrace_organization,ubtrace_project, andubtrace_versionso theubtraceSphinx builder works out of the boxCustomers can now build ubTrace-compatible output directly from the repo without any local modifications.
Usage
Build ubTrace-compatible output:
Import into ubTrace:
Test plan
sphinx-build -b ubtraceproduces valid output (needs.json,*.fjson,ubtrace_project.toml)sphinx-build -b htmlstill works unchangedmake import-buildIssue
closes #29