Install & upgrade#

Requirements#

t-doc requires the following software to be installed:

Python 3.13
Graphviz, for graphviz directives
Mercurial, for managing source files

Windows#

Install Python.
```
winget install --id Python.Python.3.13
```
- 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
```

winget install --id TortoiseHg.TortoiseHg

(Optional, Windows 10) Install Windows Terminal (it's already installed on Windows 11 and later).
```
winget install --id Microsoft.WindowsTerminal
```

Upgrades#

Available upgrades for these packages can be displayed and installed with winget upgrade.

winget upgrade
winget upgrade --id Python.Python.3.13
winget upgrade --id Graphviz.Graphviz
winget upgrade --id TortoiseHg.TortoiseHg
winget upgrade --id Microsoft.WindowsTerminal

macOS#

Install Python, Graphviz and Mercurial manually or via a package manager like Homebrew.

Linux#

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

Install#

Install the required packages.
If this is the first time you access a t-doc repository, generate a repository access password.
- Go to tdoc.org and ensure you are logged in.
- In the navigation bar, select " → Settings", then open "Repository access".
- Click "Reset" to generate the password. Keep the dialog open for the next step.
Edit the Mercurial configuration for your user. If the file doesn't exist yet, create it as an empty plain-text file.
- Windows: %USERPROFILE%\.hgrc (typically C:\Users\USERNAME\.hgrc)
- macOS: $HOME/.hgrc (typically /Users/USERNAME/.hgrc)
- Linux: $HOME/.hgrc (typically /home/USERNAME/.hgrc)
Copy the [auth] section from the dialog above (if you generated a new password) or from another install (if you already had a password), and paste it into the configuration. Also, add a [ui] section and specify your username (substitute FIRST and LAST with your first and last name, and EMAIL with your email address, e.g. Joe Smith <joe@example.com>). Save the file.
```
[auth]
t-doc.prefix = https://rc.t-doc.org/
t-doc.username = USER_ID
t-doc.password = PASSWORD

[ui]
username = FIRST LAST <EMAIL>
```
Everything else will be installed automatically when starting the local server.

Upgrade#

The local server indicates when an upgrade is available.

Check the changes introduced in the new version in the release notes.
Restart the local server. When prompted, accept the upgrade.

Install & upgrade

Contents