How To Install sphinxcontrib-autoprogram on Ubuntu 18.04
Introduction
In this tutorial we learn how to install sphinxcontrib-autoprogram on Ubuntu 18.04.
What is sphinxcontrib-autoprogram
sphinxcontrib-autoprogram is:
This contrib extension, sphinxcontrib.autoprogram, provides an automated way to document CLI programs. It scans argparse.ArgumentParser object, and then expands it into a set of .. program:: and .. option:: directives.
In order to use it, add sphinxcontrib.autoprogram into extensions list of your Sphinx configuration file (conf.py)
This package contains the Python 2 version.
There are three methods to install sphinxcontrib-autoprogram 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 sphinxcontrib-autoprogram Using apt-get
Update apt database with apt-get using the following command.
sudo apt-get update
After updating apt database, We can install sphinxcontrib-autoprogram using apt-get by running the following command:
sudo apt-get -y install sphinxcontrib-autoprogram
Install sphinxcontrib-autoprogram Using apt
Update apt database with apt using the following command.
sudo apt update
After updating apt database, We can install sphinxcontrib-autoprogram using apt by running the following command:
sudo apt -y install sphinxcontrib-autoprogram
Install sphinxcontrib-autoprogram 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 sphinxcontrib-autoprogram using aptitude by running the following command:
sudo aptitude -y install sphinxcontrib-autoprogram
How To Uninstall sphinxcontrib-autoprogram on Ubuntu 18.04
To uninstall only the sphinxcontrib-autoprogram package we can use the following command:
sudo apt-get remove sphinxcontrib-autoprogram
Uninstall sphinxcontrib-autoprogram And Its Dependencies
To uninstall sphinxcontrib-autoprogram and its dependencies that are no longer needed by Ubuntu 18.04, we can use the command below:
sudo apt-get -y autoremove sphinxcontrib-autoprogram
Remove sphinxcontrib-autoprogram Configurations and Data
To remove sphinxcontrib-autoprogram configuration and data from Ubuntu 18.04 we can use the following command:
sudo apt-get -y purge sphinxcontrib-autoprogram
Remove sphinxcontrib-autoprogram configuration, data, and all of its dependencies
We can use the following command to remove sphinxcontrib-autoprogram configurations, data and all of its dependencies, we can use the following command:
sudo apt-get -y autoremove --purge sphinxcontrib-autoprogram
References
Summary
In this tutorial we learn how to install sphinxcontrib-autoprogram package on Ubuntu 18.04 using different package management tools: apt, apt-get and aptitude.
