How To Install python3-sphinx-paramlinks on Ubuntu 18.04

In this tutorial we learn how to install python3-sphinx-paramlinks on Ubuntu 18.04. python3-sphinx-paramlinks is Sphinx extension to make param links linkable (Python 3 version)

Introduction

In this tutorial we learn how to install python3-sphinx-paramlinks on Ubuntu 18.04.

python3-sphinx-paramlinks is:

Sphinx extension which allows :param: directives within Python documentation to be linkable.

Features:

  • :param: directives within Sphinx function/method descriptions will be given aparagraph link so that they can be linked to externally.
  • a new text role :paramref: is added, which works like :meth:, :func:, etc.

This package contains Python 3.x version of sphinx_paramlinks module.

There are three methods to install python3-sphinx-paramlinks 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.

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

sudo apt-get update

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

sudo apt-get -y install python3-sphinx-paramlinks

Update apt database with apt using the following command.

sudo apt update

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

sudo apt -y install python3-sphinx-paramlinks

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-sphinx-paramlinks using aptitude by running the following command:

sudo aptitude -y install python3-sphinx-paramlinks

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

sudo apt-get remove python3-sphinx-paramlinks

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

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

To remove python3-sphinx-paramlinks configuration and data from Ubuntu 18.04 we can use the following command:

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

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

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

References

Summary

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