Information about the package, python-sphinx, which is shipped with common Linux distributions. The python-sphinx package is designed for, Python documentation generator.
Package Name:
python-sphinx
Summary:
Python documentation generator
Description:
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils. Although it is still under constant development, the following features are already present, work fine and can be seen "in action" in the Python docs: * Output formats: HTML (including Windows HTML Help) and LaTeX, for printable PDF versions * Extensive cross-references: semantic markup and automatic links for functions, classes, glossary terms and similar pieces of information * Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children * Automatic indices: general index as well as a module index * Code handling: automatic highlighting using the Pygments highlighter * Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings.
Architecture:
noarch
Version:
0.6.6
Release:
2.el6
Size:
487 k
Repository:
base
From Repository:
Licence:
BSD
Control the python-sphinx package with the following handy commands outlined below.
yum install python-sphinx
This command will install python-sphinx on the server.
yum remove python-sphinx
This command will un-install python-sphinx on the server. When you run this command, you will be asked if you are sure that you want to remove python-sphinx, so you have to manually confirm that you want to do this.
yum -y remove python-sphinx
This command will un-install python-sphinx on the server. When you run this command with th e -y flag, you will not be prompted to check that you are sure you want to remove the package - so be sure you absolutely want to remove python-sphinx when using the -y flag.
yum update python-sphinx
This command will update python-sphinx to the latest version. When you run this command, you will be asked if you are sure that you want to remove python-sphinx, so you have to manually confirm that you want to do this.
yum -y update python-sphinx
This command will update python-sphinx to the latest version. When you run this command with the -y flag, you will not be prompted to check that you are sure you want to remove the package - so be sure you absolutely want to remove python-sphinx when using the -y flag.
yum info python-sphinx
This command will show you core information about the python-sphinx package.
yum deplist python-sphinx
This command will show you the dependencies for python-sphinx. Thankfully, when using Yum, if dependencies are required, these are also installed at the same time so you don't have to worry too much about that.
yum check-update python-sphinx
This command will check if there is an update waiting on python-sphinx. When you run this command this will return nothing if there is nothing to update, or, will return the package name if the package is due to be updated.