How To Install python3-sphinxcontrib.autoprogram on Ubuntu 18.04

In this tutorial we learn how to install python3-sphinxcontrib.autoprogram on Ubuntu 18.04. python3-sphinxcontrib.autoprogram is automated documentation of CLI programs for Sphinx (Python 3)

Introduction

In this tutorial we learn how to install python3-sphinxcontrib.autoprogram on Ubuntu 18.04.

What is python3-sphinxcontrib.autoprogram

python3-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 3 version.

There are three methods to install python3-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 python3-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 python3-sphinxcontrib.autoprogram using apt-get by running the following command:

sudo apt-get -y install python3-sphinxcontrib.autoprogram

Install python3-sphinxcontrib.autoprogram Using apt

Update apt database with apt using the following command.

sudo apt update

After updating apt database, We can install python3-sphinxcontrib.autoprogram using apt by running the following command:

sudo apt -y install python3-sphinxcontrib.autoprogram

Install python3-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 python3-sphinxcontrib.autoprogram using aptitude by running the following command:

sudo aptitude -y install python3-sphinxcontrib.autoprogram

How To Uninstall python3-sphinxcontrib.autoprogram on Ubuntu 18.04

To uninstall only the python3-sphinxcontrib.autoprogram package we can use the following command:

sudo apt-get remove python3-sphinxcontrib.autoprogram

Uninstall python3-sphinxcontrib.autoprogram And Its Dependencies

To uninstall python3-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 python3-sphinxcontrib.autoprogram

Remove python3-sphinxcontrib.autoprogram Configurations and Data

To remove python3-sphinxcontrib.autoprogram configuration and data from Ubuntu 18.04 we can use the following command:

sudo apt-get -y purge python3-sphinxcontrib.autoprogram

Remove python3-sphinxcontrib.autoprogram configuration, data, and all of its dependencies

We can use the following command to remove python3-sphinxcontrib.autoprogram configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge python3-sphinxcontrib.autoprogram

References

Summary

In this tutorial we learn how to install python3-sphinxcontrib.autoprogram package on Ubuntu 18.04 using different package management tools: apt, apt-get and aptitude.