cederom commented on PR #18379:
URL: https://github.com/apache/nuttx/pull/18379#issuecomment-3900938296
* Okay so I tried locally.
* `pipenv update` is required after this change to install `plantuml`
extensions to `sphinx` :-)
* And `plantuml` should be installed in the system before `pipenv` is
created/updated as dependency to sphinx-plantuml.
```
% gmake autobuild
Removing everything under '_build'...
[sphinx-autobuild] > sphinx-build -j auto -W
/zraid/data/cederom/work/CeDeROM/lab/embedded/nuttx/pr/nuttx.git/Documentation
/zraid/data/cederom/work/CeDeROM/lab/embedded/nuttx/pr/nuttx.git/Documentation/_build
Running Sphinx v6.2.1
Extension error:
Could not import extension sphinxcontrib.plantuml (exception: No module
named 'sphinxcontrib.plantuml')
Command exited with exit code: 2
% pipenv update
Installing dependencies from Pipfile.lock (30770f)...
All dependencies are now up-to-date!
Upgrading sphinx_rtd_theme, Sphinx, MarkupSafe in dependencies.
Building requirements...
Resolving dependencies...
✔ Success!
Building requirements...
Resolving dependencies...
✔ Success!
Installing dependencies from Pipfile.lock (30770f)...
All dependencies are now up-to-date!
% gmake autobuild
Removing everything under '_build'...
[sphinx-autobuild] Starting initial build
[sphinx-autobuild] > python -m sphinx . _build -j auto -W
Running Sphinx v6.2.1
myst v3.0.1: MdParserConfig(commonmark_only=False, gfm_only=False,
enable_extensions=set(), disable_syntax=[], all_links_external=False,
links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'),
ref_domains=None, fence_as_directive=set(), number_code_blocks=[],
title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={},
footnote_transition=True, words_per_minute=200, substitutions={},
linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True,
dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True,
mathjax_classes='tex2jax_process|mathjax_process|math|output_area',
enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
Tags updated
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1483 source files that are out of date
updating environment: [new config] 1486 added, 0 changed, 0 removed
reading sources... [100%] reference/user/01_task_control .. testing/index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] reference/user/13_boardctl .. testing/index
generating indices... genindex done
writing additional pages... search done
copying images... [100%] _static/images/menuconfig-debug.png
copying downloadable files... [100%]
components/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in _build.
[sphinx-autobuild] Serving on http://127.0.0.1:8000
[sphinx-autobuild] Waiting to detect changes...
```
This build already points to
http://localhost:8000/_images/plantuml-6fc4b6847ab85f76e22a6f8abe5188797729d229.png
so this is uml generated image, very nice!! =)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
