< Home - < Back

epydoc


Information about the package, epydoc, which is shipped with common Linux distributions. The epydoc package is designed for, Automatic API documentation generation tool for Python.


Package Name:

epydoc

Summary:

Automatic API documentation generation tool for Python

Description:

Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. For an example of epydoc's output, see the API documentation for epydoc itself (html, pdf). A lightweight markup language called epytext can be used to format docstrings, and to add information about specific fields, such as parameters and instance variables. Epydoc also understands docstrings written in ReStructuredText, Javadoc, and plaintext.

Architecture:

noarch

Version:

3.0.1

Release:

6.el6

Size:

1.6 M

Repository:

base

From Repository:

Licence:

MIT



Handy Yum Commands for epydoc


Control the epydoc package with the following handy commands outlined below.


Command

Description of Command

yum install epydoc

This command will install epydoc on the server.

yum remove epydoc

This command will un-install epydoc on the server. When you run this command, you will be asked if you are sure that you want to remove epydoc, so you have to manually confirm that you want to do this.

yum -y remove epydoc

This command will un-install epydoc 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 epydoc when using the -y flag.

yum update epydoc

This command will update epydoc to the latest version. When you run this command, you will be asked if you are sure that you want to remove epydoc, so you have to manually confirm that you want to do this.

yum -y update epydoc

This command will update epydoc 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 epydoc when using the -y flag.

yum info epydoc

This command will show you core information about the epydoc package.

yum deplist epydoc

This command will show you the dependencies for epydoc. 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 epydoc

This command will check if there is an update waiting on epydoc. 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.