Installing Doxide¶
Follow the instructions below for your operating system.
Linux¶
Install Doxide from your package manager by adding appropriate repository for your Linux distribution below. If your distribution is not listed, you can instead install from source.
Ubuntu 24.10 Oracular Oriole (amd64)
Install Doxide:
echo 'deb http://download.indii.org/deb oracular main' | sudo tee /etc/apt/sources.list.d/indii.org.list
curl -fsSL https://download.indii.org/deb/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/indii.org.gpg > /dev/null
sudo apt update
sudo apt install doxide
Ubuntu 24.04 Noble Numbat (amd64)
Install Doxide:
echo 'deb http://download.indii.org/deb noble main' | sudo tee /etc/apt/sources.list.d/indii.org.list
curl -fsSL https://download.indii.org/deb/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/indii.org.gpg > /dev/null
sudo apt update
sudo apt install doxide
Debian 12 Bookworm (amd64)
Install Doxide:
echo 'deb http://download.indii.org/deb bookworm main' | sudo tee /etc/apt/sources.list.d/indii.org.list
curl -fsSL https://download.indii.org/deb/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/indii.org.gpg > /dev/null
sudo apt update
sudo apt install doxide
Fedora 40 (x86_64)
Install Doxide:
sudo dnf config-manager --add-repo https://download.indii.org/rpm/fedora/40/indii.org.repo
sudo dnf update
sudo dnf install doxide
Fedora 39 (x86_64)
Install Doxide:
sudo dnf config-manager --add-repo https://download.indii.org/rpm/fedora/39/indii.org.repo
sudo dnf update
sudo dnf install doxide
openSUSE Tumbleweed (x86_64)
Install Doxide:
sudo zypper addrepo https://download.indii.org/rpm/opensuse/tumbleweed/indii.org.repo
sudo zypper refresh
sudo zypper install doxide
Arch
Available from the Arch User Repository (AUR).
Then install MkDocs and Material for MkDocs:
pip install mkdocs mkdocs-material
Material for MkDocs is included as a package in some Linux distributions, but typically an older version, and mileage may vary when using it with Doxide. As Material for MkDocs is updated frequently, it is recommended to install it with pip instead, to get the latest version.
Mac¶
Install Homebrew if not already, then:
brew tap lawmurray/all
brew install doxide
pip install mkdocs mkdocs-material
Windows¶
First install Doxide via your preferred means:
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 your chosen Linux distribution 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
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
source venv/bin/activate
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