Commit graph

5 commits

Author SHA1 Message Date
markd
c946b8b1d0 add LICENSE 2009-08-05 10:43:12 +00:00
markd
bfbef2ac4b Update to sphinx 0.6.2
* Incompatible changes:

  - Templating now requires the Jinja2 library

  - The "document" div tag has been moved out of the ``layout.html``
    template's "document" block

  - The ``autodoc_skip_member`` event now also gets to decide
    whether to skip members whose name starts with underscores.

* Theming support

* Markup:

  - Due to popular demand, added a ``:doc:`` role which directly
    links to another document without the need of creating a
    label to which a ``:ref:`` could link to.

  - Added a ``:download:`` role that marks a non-document file
    for inclusion into the HTML output and links to it.

  - Added an ``only`` directive that can selectively include text
    based on enabled "tags".

  - Added HTML section numbers, enabled by giving a
    ``:numbered:`` flag to the ``toctree`` directive.

  - Scaled images now get a link to the unscaled version.

  - SVG images are now supported in HTML (via ``<object>`` and
    ``<embed>`` tags).

* Builders:

  - New builder for Qt help collections, by Antonio Valentino.

  - The new ``DirectoryHTMLBuilder`` (short name ``dirhtml``) creates
    a separate directory for every page, and places the page there
    in a file called ``index.html``.

* New translations:

* Bug Fixes.
2009-08-05 10:41:17 +00:00
joerg
73ae0afd90 Remove @dirrm entries from PLISTs 2009-06-14 18:17:11 +00:00
markd
5dc77fe00e Note py-jinja dependency.
pkgsrc's docutils doesn't install an egg-info so dont note the requirement
in this egg-info as it wont be detected.
Bump PKGREVISION.
2009-02-02 09:44:44 +00:00
markd
54e669eda0 Import py-sphinx 0.5.1
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), plain text 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.
2009-01-31 05:31:13 +00:00