How To Install python-zzzeeksphinx on Ubuntu 18.04

In this tutorial we learn how to install python-zzzeeksphinx on Ubuntu 18.04. python-zzzeeksphinx is Zzzeeks Sphinx layout and utilities

Introduction

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

What is python-zzzeeksphinx

python-zzzeeksphinx is:

This layout is first and foremost pulled in for the SQLAlchemy documentation builds (and possibly other related projects), but is also usable as a standalone theme / utility set for any project.

Features include:

  • uses Mako templates instead of Jinja, for more programmatic capabilities inside of templates
  • layout includes an independently scrollable sidebar
  • unique (to Sphinx) “contextual” sidebar contents that shows the current page in context with all sibling pages
  • modifications to autodoc which illustrate inherited classes, bases, method documentation illustrates if a method is only inherited from the base or overridden
  • “dynamic base” feature that will, under ReadTheDocs, pull in optional .mako and .py files from the website of your choice that will serve as an alternate base template and a source of extra config setup, respectively, allowing the layout to be integrated into the layout of an external site when viewing on the web
  • “viewsource” extension that can provide highlighted sourcecode to any Python file arbitrarily
  • SQLAlchemy-specific stuff, like the [SQL] popups, the dialect info directives
  • scss support using pyscss

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

sudo apt-get -y install python-zzzeeksphinx

Install python-zzzeeksphinx Using apt

Update apt database with apt using the following command.

sudo apt update

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

sudo apt -y install python-zzzeeksphinx

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

sudo aptitude -y install python-zzzeeksphinx

How To Uninstall python-zzzeeksphinx on Ubuntu 18.04

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

sudo apt-get remove python-zzzeeksphinx

Uninstall python-zzzeeksphinx And Its Dependencies

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

sudo apt-get -y autoremove python-zzzeeksphinx

Remove python-zzzeeksphinx Configurations and Data

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

sudo apt-get -y purge python-zzzeeksphinx

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

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

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

References

Summary

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