./textproc/py-sphinx, Python documentation generator

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]


Branch: CURRENT, Version: 1.5.1, Package name: py27-sphinx-1.5.1, Maintainer: markd

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.


Required to run:
[textproc/py-docutils] [devel/py-setuptools] [time/py-pytz] [devel/py-babel] [textproc/py-pygments] [textproc/py-jinja2] [lang/python27] [devel/py-requests] [lang/py-six] [textproc/py-snowballstemmer] [textproc/py-alabaster] [textproc/py-sphinx-rtd-theme] [graphics/py-imagesize]

Required to build:
[devel/py-nose] [pkgtools/cwrappers]

Master sites:

SHA1: 4c413bd6310f4452c5fbeb9493065fc3dd968210
RMD160: a938285fc310e86ded124fce309222b9423e2a7f
Filesize: 4294.186 KB

Version history: (Expand)


CVS history: (Expand)


   2017-01-03 14:23:05 by Jonathan Perkin | Files touched by this commit (52)
Log message:
Use "${MV} || ${TRUE}" and "${RM} -f" consistently in \ 
post-install targets.
   2016-12-16 21:05:59 by Adam Ciarcinski | Files touched by this commit (1)
Log message:
Remove .pyc file after extraction
   2016-12-16 14:59:13 by Joerg Sonnenberger | Files touched by this commit (1)
Log message:
List files only once.
   2016-12-15 12:04:10 by Adam Ciarcinski | Files touched by this commit (1)
Log message:
Added py-requests to DEPENDS
   2016-12-15 11:48:17 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
Release 1.5.1 (released Dec 13, 2016)
=====================================
Features added
--------------
* 3214: Allow to suppress "unknown mimetype" warnings from epub \ 
builder using
  :confval:`suppress_warnings`.

Bugs fixed
----------
* 3195: Can not build in parallel
* 3198: AttributeError is raised when toctree has 'self'
* 3211: Remove untranslated sphinx locale catalogs (it was covered by
  untranslated it_IT)
* 3212: HTML Builders crashes with docutils-0.13
* 3207: more latex problems with references inside parsed-literal directive
  (``\DUrole``)
* 3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)
* 3220: KeyError when having a duplicate citation
* 3200: LaTeX: xref inside desc_name not allowed
* 3228: ``build_sphinx`` command crashes when missing dependency
* 2469: Ignore updates of catalog files for gettext builder. Thanks to
  Hiroshi Ohkubo.
* 3183: Randomized jump box order in generated index page.
   2016-08-28 17:48:37 by Thomas Klausner | Files touched by this commit (112)
Log message:
Remove unnecessary PLIST_SUBST and FILES_SUBST that are now provided
by the infrastructure.

Mark a couple more packages as not ready for python-3.x.
   2016-06-08 19:43:49 by Thomas Klausner | Files touched by this commit (356)
Log message:
Switch to MASTER_SITES_PYPI.
   2016-04-23 19:48:55 by Adam Ciarcinski | Files touched by this commit (4) | Package updated
Log message:
Release 1.4.1:

Incompatible changes
--------------------
* The default format of `today_fmt` and `html_last_updated_fmt` is back to
  strftime format again.  Locale Date Markup Language is also supported for
  backward compatibility until Sphinx-1.5.

Translations
------------
* Added Welsh translation, thanks to Geraint Palmer.
* Added Greek translation, thanks to Stelios Vitalis.
* Added Esperanto translation, thanks to Dinu Gherman.
* Added Hindi translation, thanks to Purnank H. Ghumalia.
* Added Romanian translation, thanks to Razvan Stefanescu.

Bugs fixed
----------
* C++, added support for ``extern`` and ``thread_local``.
* C++, type declarations are now using the prefixes ``typedef``, ``using``, and \ 
``type``,
  depending on the style of declaration.
* 2413: C++, fix crash on duplicate declarations
* 2394: Sphinx crashes when html_last_updated_fmt is invalid
* 2408: dummy builder not available in Makefile and make.bat
* 2412: hyperlink targets are broken in LaTeX builder
* figure directive crashes if non paragraph item is given as caption
* 2418: time formats no longer allowed in today_fmt
* 2395: Sphinx crashes if unicode character in image filename
* 2396: "too many values to unpack" in genindex-single
* 2405: numref link in PDF jumps to the wrong location
* 2414: missing number in PDF hyperlinks to code listings
* 2440: wrong import for gmtime.