Скачать или смотреть How to Specify the PlantUML Version on ReadTheDocs

Learn how to ensure you're using the latest `PlantUML` features in your Sphinx project hosted on ReadTheDocs by specifying the correct version.
---
This video is based on the question https://stackoverflow.com/q/77869766/ asked by the user 'CampbellB' ( https://stackoverflow.com/u/21022386/ ) and on the answer https://stackoverflow.com/a/78077823/ provided by the user 'Hudson' ( https://stackoverflow.com/u/23499158/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How do I specify the plantuml version with ReadTheDocs?

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Specify the PlantUML Version on ReadTheDocs

If you're working with PlantUML in your Sphinx documentation project hosted on ReadTheDocs, you may have encountered a common issue: the platform installs an older version of PlantUML, preventing you from accessing the latest features. In this post, we'll explore how to specify the desired version of PlantUML in your ReadTheDocs configuration, ensuring you can utilize the newest functionality that the software offers.

The Problem: Outdated PlantUML Version

During the build process on ReadTheDocs, you may notice your project installs a version of PlantUML like 1.2020.2, which may lack the features you need for your documentation. This outdated version can be frustrating, especially if you've been counting on newer functionality.

To remedy this, let’s dive into how you can specify the version of PlantUML you want to use.

Solution: Custom Pre-install Script

To upgrade to a specific version of PlantUML, you can set up a custom pre-installation script. This will ensure that the latest version is downloaded and used during the build process. Here’s how to configure it:

Step 1: Create the Pre-install Script

In your project directory, create a new file at wiki/scripts/pre_install.sh.

Open this file and add the following code:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Update Your Configuration File

Next, you need to ensure that ReadTheDocs knows about your pre-install script. Update your .readthedocs.yaml file to include the new script:

[[See Video to Reveal this Text or Code Snippet]]

Explanation of the Script

The script starts with a shebang (# !/bin/bash) which directs the system to use bash to run the script.

It also sets options to stop on errors and print commands as they are executed, which helps with debugging.

It checks if Java and Graphviz are installed, as they are prerequisites for PlantUML.

The script uses curl to download the specified version of plantuml.jar from the official GitHub repository—make sure to replace v1.2024.3 with the version you need if different.

It then creates a wrapper script for PlantUML that allows you to run the command from anywhere within your environment.

Finally, it runs plantuml -version to verify that the correct version has been installed.

Conclusion

With this setup, you can effectively control the version of PlantUML that is utilized during your documentation builds on ReadTheDocs. It's a straightforward process that ensures you're making the most of the features available in the latest versions of PlantUML. By following the instructions outlined above, you can eliminate any frustrating issues related to outdated software.

Now, you're ready to document your projects with the best tools available. Happy documenting!