AdeliaDoc is a Windows "command line"-type tool ® in Adelia Studio . It is installed as standard with Adelia Studio on a Windows operating system®.
As AdeliaDoc uses the Sphinx documentation generator, this tool needs to be installed before using AdeliaDoc.
As Sphinx is a product developed in Python, version 3.6 or later of a Python environment needs to be installed on the machine on which AdeliaDoc will be run.
If you want to produce documentation in PDF format, you also need to install a full TeX/LaTeX environment (preferably MikTex).
We therefore suggest that you install the required third-party products in the following order:
- Python 3.6+:
- Before installing Python, you can check that there is not already a version installed by opening a Windows® (⊞Win-r and enter cmd ), typing the python --version command then pressing Enter.
- If Python is already installed, the installed version is displayed on the screen.
If not, or if the version is earlier than version 3.6, refer to "The Hitchhiker's Guide to Python", "Installing Python 3 on Windows" section to install or update Python. - Alternatively, you can obtain an installer directly via the following link: https://www.python.org/downloads/.
- Sphinx 3.5+:
- Once Python is installed, refer to the "Windows" section of the Sphinx installation help page to install it using the Python Package Installer.
- Alternatively, you can install Python and Sphinx via Chocolatey.
In this case, Chocolatey must be previously installed. Then refer to the Chocolatey page dedicated to the Sphinx package.
- MikTex (for PDF only):
- Follow the instructions on the MikTex.org website.
- In order for the PDF production chain to function correctly, ensure that the MikTex binary directory is in the
PATHof your Windows® session (".\MiKTeX\miktex\bin\x64").
- MikTex requires Perl. So it is also necessary to install this tool.
- Finally, and if it has not already been installed, open the MikTex package manager and install the latexmk package.