Skip to content

Change PlantUML output format from 'svg_img' to 'svg' - #69

Open
PhilipPartsch wants to merge 8 commits into
useblocks:mainfrom
PhilipPartsch:main
Open

PhilipPartsch wants to merge 8 commits into
useblocks:mainfrom
PhilipPartsch:main

Conversation

@PhilipPartsch

Copy link
Copy Markdown
Contributor

No description provided.

@PhilipPartsch

Copy link
Copy Markdown
Contributor Author

@danwos To have clickable pics, we do need this

Each demo project (basic_example, coffee-machine, automotive-adas,
safety_example) now has its own conf.py/ubproject.toml, trimmed to only
what it uses, instead of sharing one at docs/. docs/ itself becomes a
minimal landing project linking to the four demos. Variants/ubtrace are
scoped to automotive-adas only, since it's the only project using them.

All 5 still share this repo's single uv venv. Added scripts/build_docs.sh
as the one shared entry point, used by ci.yaml, ubtrace.yml, and
.readthedocs.yaml. All 5 build clean with `sphinx-build -W`.
Add a sidebar block linking between all 5 projects, validated via
intersphinx for the existing cross-project links. Centralize _static,
_shared_templates, the plantuml jar, and the logo/favicon into single
docs.
- Update CI workflow to run 'ubc check' on each independent project.
- Modify .readthedocs.yaml to pre-install both ubt-sphinx and ubt-runtime.
- Refactor conf.py to dynamically determine inventory file paths based on build output location.
- Adjust safety_example's conf.py for correct inventory path resolution.
- Update safety_example's ubproject.toml to exclude unnecessary files from ubc checks.
- Refine landing project's ubproject.toml to prevent ubc from checking sub-projects.
- Export OUTPUT_DIR as an absolute path in build_docs.sh for consistent inventory access.
python.install silently doesn't run once build.jobs.build.html is set,
so `pip install .` never happened and builds failed with "No module
named sphinx_needs". Confirmed via the actual RTD build's command log.
…es and needflows after rework of repo structure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant