How To Install mkdocstrings on Debian 12
Introduction
In this tutorial we learn how to install mkdocstrings on Debian 12.
What is mkdocstrings
mkdocstrings is:
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
This package contains an plugin for MkDocs to build automatic documentation from docstrings within your source code files.
There are three methods to install mkdocstrings on Debian 12. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.
Install mkdocstrings Using apt-get
Update apt database with apt-get using the following command.
sudo apt-get update
After updating apt database, We can install mkdocstrings using apt-get by running the following command:
sudo apt-get -y install mkdocstrings
Install mkdocstrings Using apt
Update apt database with apt using the following command.
sudo apt update
After updating apt database, We can install mkdocstrings using apt by running the following command:
sudo apt -y install mkdocstrings
Install mkdocstrings Using aptitude
If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Debian. Update apt database with aptitude using the following command.
sudo aptitude update
After updating apt database, We can install mkdocstrings using aptitude by running the following command:
sudo aptitude -y install mkdocstrings
How To Uninstall mkdocstrings on Debian 12
To uninstall only the mkdocstrings package we can use the following command:
sudo apt-get remove mkdocstrings
Uninstall mkdocstrings And Its Dependencies
To uninstall mkdocstrings and its dependencies that are no longer needed by Debian 12, we can use the command below:
sudo apt-get -y autoremove mkdocstrings
Remove mkdocstrings Configurations and Data
To remove mkdocstrings configuration and data from Debian 12 we can use the following command:
sudo apt-get -y purge mkdocstrings
Remove mkdocstrings configuration, data, and all of its dependencies
We can use the following command to remove mkdocstrings configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge mkdocstrings
Dependencies
mkdocstrings have the following dependencies:
References
Summary
In this tutorial we learn how to install mkdocstrings package on Debian 12 using different package management tools: apt, apt-get and aptitude.
