How To Install epydoc-doc on Ubuntu 18.04

In this tutorial we learn how to install epydoc-doc on Ubuntu 18.04. epydoc-doc is tool for documenting Python modules (documentation)

Introduction

In this tutorial we learn how to install epydoc-doc on Ubuntu 18.04.

What is epydoc-doc

epydoc-doc is:

Epydoc is a tool for generating API documentation for Python modules based on their docstrings. A lightweight markup language called epytext can be used to format docstrings and to add information about specific fields, such as parameters and instance variables. Epydoc also understands docstrings written in ReStructuredText, Javadoc, and plaintext.

This package contains the API reference and usage information for Epydoc, all available through the Debian documentation system (dhelp, dwww, doc-central, etc.) in the Devel section.

There are three methods to install epydoc-doc 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 epydoc-doc Using apt-get

Update apt database with apt-get using the following command.

sudo apt-get update

After updating apt database, We can install epydoc-doc using apt-get by running the following command:

sudo apt-get -y install epydoc-doc

Install epydoc-doc Using apt

Update apt database with apt using the following command.

sudo apt update

After updating apt database, We can install epydoc-doc using apt by running the following command:

sudo apt -y install epydoc-doc

Install epydoc-doc 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 epydoc-doc using aptitude by running the following command:

sudo aptitude -y install epydoc-doc

How To Uninstall epydoc-doc on Ubuntu 18.04

To uninstall only the epydoc-doc package we can use the following command:

sudo apt-get remove epydoc-doc

Uninstall epydoc-doc And Its Dependencies

To uninstall epydoc-doc and its dependencies that are no longer needed by Ubuntu 18.04, we can use the command below:

sudo apt-get -y autoremove epydoc-doc

Remove epydoc-doc Configurations and Data

To remove epydoc-doc configuration and data from Ubuntu 18.04 we can use the following command:

sudo apt-get -y purge epydoc-doc

Remove epydoc-doc configuration, data, and all of its dependencies

We can use the following command to remove epydoc-doc configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge epydoc-doc

References

Summary

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