How To Install python-epydoc on Ubuntu 18.04

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

Introduction

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

What is python-epydoc

python-epydoc 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 epydoc and epydocgui commands, their manpages, and their associated Python modules.

Epydoc supports two output formatters: HTML and LaTeX. You must install the suggested dependencies in order to generate documentation in DVI, PostScript, or PDF format using the LaTeX formatter.

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

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

sudo apt-get update

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

sudo apt-get -y install python-epydoc

Install python-epydoc Using apt

Update apt database with apt using the following command.

sudo apt update

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

sudo apt -y install python-epydoc

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

sudo aptitude -y install python-epydoc

How To Uninstall python-epydoc on Ubuntu 18.04

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

sudo apt-get remove python-epydoc

Uninstall python-epydoc And Its Dependencies

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

sudo apt-get -y autoremove python-epydoc

Remove python-epydoc Configurations and Data

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

sudo apt-get -y purge python-epydoc

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

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

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

References

Summary

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