certik / prettydoc

Automatically exported from code.google.com/p/prettydoc
0 stars 0 forks source link

Have a look at Sphinx #4

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
To: Doc-Sig@python.org
From: Georg Brandl <g.brandl@gmx.net>
Date: Fri, 21 Mar 2008 18:39:37 +0100
Subject: [Doc-SIG] Sphinx released to PyPI

I'm delighted to announce that the Sphinx library, used to build the
new Python documentation (for 2.6 and 3.0) [1], is now released for
general use.

What is it?
===========

Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of
multiple reStructuredText source files).

Its website is at <http://sphinx.pocoo.org/>.

What does it do?
================

Sphinx is not an API documentation generator like Epydoc.  Instead, its
focus is on hand-written documentation, such as the Python one.

* Main output formats: HTML (including HTML Help) and LaTeX

* 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

* Goodies such as changes overview, and external link checking

What else?
==========

Various extensions are available and in development:

* autodoc: pulls in documentation from docstrings that are written in
    reST, to avoid having to maintain multiple documentation locations

* doctest: automatically tests snippets in the documentation in doctest
    fashion

* coverage: documentation coverage checker

Original issue reported on code.google.com by kirill.s...@gmail.com on 22 Mar 2008 at 10:14

GoogleCodeExporter commented 9 years ago
Maybe this could be useful...

Original comment by kirill.s...@gmail.com on 22 Mar 2008 at 10:14

GoogleCodeExporter commented 9 years ago
Yes, Gael sent me this already. Let's use it.

Original comment by ondrej.c...@gmail.com on 22 Mar 2008 at 12:20