How To Install python-sphinx on Debian 10

Learn how to install python-sphinx on Debian 10 with this tutorial. python-sphinx is documentation generator for Python projects (implemented in Python 2)

Introduction

In this tutorial we learn how to install python-sphinx on Debian 10.

What is python-sphinx

python-sphinx is:

Sphinx is a tool for producing documentation for Python projects, using reStructuredText as markup language.

Sphinx features:

  • HTML, CHM, LaTeX output,
  • Cross-referencing source code,
  • Automatic indices,
  • Code highlighting, using Pygments,
  • Extensibility. Existing extensions:
    • automatic testing of code snippets,
    • including docstrings from Python modules.

This package includes Python 2 modules and command line utilities.

There are three methods to install python-sphinx on Debian 10. 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-sphinx 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-sphinx using apt-get by running the following command:

sudo apt-get -y install python-sphinx

Install python-sphinx Using apt

Update apt database with apt using the following command.

sudo apt update

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

sudo apt -y install python-sphinx

Install python-sphinx 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 Debian. Update apt database with aptitude using the following command.

sudo aptitude update

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

sudo aptitude -y install python-sphinx

How To Uninstall python-sphinx on Debian 10

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

sudo apt-get remove python-sphinx

Uninstall python-sphinx And Its Dependencies

To uninstall python-sphinx and its dependencies that are no longer needed by Debian 10, we can use the command below:

sudo apt-get -y autoremove python-sphinx

Remove python-sphinx Configurations and Data

To remove python-sphinx configuration and data from Debian 10 we can use the following command:

sudo apt-get -y purge python-sphinx

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

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

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

Dependencies

python-sphinx have the following dependencies:

References

Summary

In this tutorial we learn how to install python-sphinx package on Debian 10 using different package management tools: apt, apt-get and aptitude.