-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document plantuml usage #3885
Comments
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Thanks for providing the needed plantuml command 👍 The extension Sphinx-Needs is using plantuml for some stuff and I have just added an installation section how to use it for rtd: If I find some time, I'll write the needed docs. But unfortunately not in the next days. So here is the text as screenshot. For the latest version (and text to copy) see link above. |
I cannot seem to get this to work on readthedocs since I get the error: |
@CThuleHansen you need to install the extension on rtd, see https://docs.readthedocs.io/en/stable/guides/specifying-dependencies.html |
@stsewd thank you! It works now. |
Java (and therefore plantuml) seems to be not installed, when using the build-commands feature. The "apt_packages" config option seems not to be taken into account. |
Hi @danwos! You are correct. Please, if you have the time, consider opening an issue for this so we track it independently from the plantuml one. |
Thanks for the fast answer. |
In this other issue #9958 (comment), there is an updated version about how to use PlantUML. It also uses a local version of PlantUML, so it can be the latest one if required. |
Document how to use sphinxcontrib-plantuml with RTD.
Because X11 isn't exposed through docker, java needs to be called in headless mode. Heck, we can likely set this in our conf.py template as well, so that users have the correct config.
To get it to work, you'll need:
Also, you need to run the
latest
image.The text was updated successfully, but these errors were encountered: