How To Install doxypy on Ubuntu 18.04
Introduction
In this tutorial we learn how to install doxypy
on Ubuntu 18.04.
What is doxypy
doxypy is:
doxypy is an input filter for Doxygen. It reformats Python comments to conform to Doxygen documentation blocks. This makes it possible to use the Doxygen/Javadoc syntax inside of docstrings when writing code documentation and automatically generate API documentation out of it instead of being forced to use non-Python documentation blocks or to document code redundantly.
There are three methods to install doxypy
on Ubuntu 18.04. We can use apt-get
, apt
and aptitude
. In the following sections we will describe each method. You can choose one of them.
Install doxypy Using apt-get
Update apt database with apt-get
using the following command.
sudo apt-get update
After updating apt database, We can install doxypy
using apt-get
by running the following command:
sudo apt-get -y install doxypy
Install doxypy Using apt
Update apt database with apt
using the following command.
sudo apt update
After updating apt database, We can install doxypy
using apt
by running the following command:
sudo apt -y install doxypy
Install doxypy 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 Ubuntu. Update apt database with aptitude
using the following command.
sudo aptitude update
After updating apt database, We can install doxypy
using aptitude
by running the following command:
sudo aptitude -y install doxypy
How To Uninstall doxypy on Ubuntu 18.04
To uninstall only the doxypy
package we can use the following command:
sudo apt-get remove doxypy
Uninstall doxypy And Its Dependencies
To uninstall doxypy
and its dependencies that are no longer needed by Ubuntu 18.04, we can use the command below:
sudo apt-get -y autoremove doxypy
Remove doxypy Configurations and Data
To remove doxypy
configuration and data from Ubuntu 18.04 we can use the following command:
sudo apt-get -y purge doxypy
Remove doxypy configuration, data, and all of its dependencies
We can use the following command to remove doxypy
configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge doxypy
References
Summary
In this tutorial we learn how to install doxypy
package on Ubuntu 18.04 using different package management tools: apt
, apt-get
and aptitude
.