How To Install python3-sphinx on Kali Linux

In this tutorial we learn how to install python3-sphinx on Kali Linux. python3-sphinx is documentation generator for Python projects

Introduction

In this tutorial we learn how to install python3-sphinx on Kali Linux.

What is python3-sphinx

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

Build-depend on sphinx if your package uses /usr/bin/sphinx-* executables. Build-depend on python3-sphinx if your package uses the Python API (for instance by calling python3 -m sphinx).

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

sudo apt-get -y install python3-sphinx

Install python3-sphinx Using apt

Update apt database with apt using the following command.

sudo apt update

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

sudo apt -y install python3-sphinx

Install python3-sphinx Using aptitude

If you want to follow this method, you might need to install aptitude on Kali Linux first since aptitude is usually not installed by default on Kali Linux. Update apt database with aptitude using the following command.

sudo aptitude update

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

sudo aptitude -y install python3-sphinx

How To Uninstall python3-sphinx on Kali Linux

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

sudo apt-get remove python3-sphinx

Uninstall python3-sphinx And Its Dependencies

To uninstall python3-sphinx and its dependencies that are no longer needed by Kali Linux, we can use the command below:

sudo apt-get -y autoremove python3-sphinx

Remove python3-sphinx Configurations and Data

To remove python3-sphinx configuration and data from Kali Linux we can use the following command:

sudo apt-get -y purge python3-sphinx

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

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

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

Dependencies

python3-sphinx have the following dependencies:

References

Summary

In this tutorial we learn how to install python3-sphinx package on Kali Linux using different package management tools: apt, apt-get and aptitude.