Installing Doxide¶

Follow the instructions below for your operating system.

Linux¶

Install from the software repository, following the instructions provided there.

Alternatively, for Arch Linux and derivatives (e.g. EndeavourOS, Garuda, Manjaro), install Doxide from the Arch User Repository (AUR).

Also install MkDocs and Material for MkDocs:

pip install mkdocs mkdocs-material

Some Linux distributions include Material for MkDocs as a package too. It is typically an older version, but may be sufficient for you.

See below for running MkDocs in a Python virtual environment instead.

Mac¶

Install Homebrew if not already, then:

brew tap lawmurray/all
brew install doxide

Also install MkDocs and Material for MkDocs:

pip install mkdocs mkdocs-material

See below for running MkDocs in a Python virtual environment instead.

Windows¶

First install Doxide via your preferred means:

Chocolatey

Install Chocolatey if not already, then:

choco install doxide

Installer

Download Doxide installer

Checksum for the download above.

Standalone program

Download the program and put it somewhere on your PATH environment variable, so that you can access it from a terminal.

Download Doxide standalone program

Checksum for the download above.

Windows Subsystem for Linux

You can use Windows Subsystem for Linux and follow the instructions for Linux above.

Then install MkDocs and Material for MkDocs. For this you will need a working Python installation; if you are using Chocolatey, a simple way is choco install python. Then install:

pip install mkdocs mkdocs-material

See below for running MkDocs in a Python virtual environment instead.

Install from source¶

If a Doxide package is not available for your operating system or you have special requirements, you can install from source. See the README.md file for instructions.

Using a Python virtual environment¶

To manage MkDocs and other Python dependencies per-project rather than system wide, you may like to use a Python virtual environment. Create it in your project directory:

python3 -m venv venv

Then enter it:

source venv/bin/activate

You can then run pip install mkdocs mkdocs-material to install MkDocs (and other dependencies) into this virtual environment, and run mkdocs from within that virtual environment to publish your Doxide documentation. When finished, exit the environment with:

deactivate