Install & upgrade#

Requirements#

t-doc requires the following software to be installed:

Python 3.12 or later
Graphviz, for {graphviz} directives
Mercurial, for managing source files

Windows#

Install Python.
```
winget install --id Python.Python.3.12
```
- Check that Python can be launched from the command-line, by running:
```
python
```
  If this opens the Microsoft Store, open Windows settings, search for "App execution aliases", and disable the "App Installer" entries for python.exe and python3.exe.
Install Graphviz. The installer must be run interactively and the "Add Graphviz to the system PATH for all users" option must be enabled.
```
winget install --id Graphviz.Graphviz --interactive
```
Install TortoiseHg.
```
winget install --id TortoiseHg.TortoiseHg
```
- Open the TortoiseHg settings, go to your user's global settings, then click "Edit file" and add the following to the configuration (substitute FIRST and LAST with your first and last name, and EMAIL with your email address, e.g. Joe Smith <joe@example.com>):
```
[ui]
username = FIRST LAST <EMAIL>
```
(Optional, Windows 10) Install Windows Terminal (it's already installed on Windows 11 and later).
```
winget install --id Microsoft.WindowsTerminal
```

macOS#

Install Python, Graphviz and Mercurial either by hand or through a package manager like Homebrew.

Linux#

Install Python, Graphviz and Mercurial through your system's package manager.

Install#

Install the required packages.
Install the t-doc-common package.
Windows
python -m pip install t-doc-common
macOS
python -m pip install --user t-doc-common
You may have to add $HOME/.local/bin to your PATH.
Linux
python -m pip install --user t-doc-common
You may have to add $HOME/.local/bin to your PATH.

Upgrade#

Check the changes introduced in the new version in the release notes.

Upgrade the t-doc-common package and any out-of-date dependencies.

Windows

python -m pip install --upgrade t-doc-common

If you get the following error, then a local server is running. Stop it with Ctrl+C or by closing its terminal window, then try again.

ERROR: Could not install packages due to an OSError: [WinError 32] The process
cannot access the file because it is being used by another process:
'c:\\users\\...\\scripts\\tdoc.exe'

macOS

python -m pip install --user --upgrade t-doc-common

Linux

python -m pip install --user --upgrade t-doc-common

Install & upgrade

Contents