./textproc/py-sphinx, Python documentation generator

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

Branch: CURRENT, Version: 1.6.3, Package name: py27-sphinx-1.6.3, 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:
[time/py-pytz] [lang/python27] [lang/py-six]

Required to build:
[converters/py-simplejson] [pkgtools/cwrappers]

Master sites:

SHA1: f33215cb1242149b9621851e090a17ec2998c9d3
RMD160: acd28eac169f8b20177348ff6b8586bd22a2166a
Filesize: 4564.698 KB

Version history: (Expand)

CVS history: (Expand)

   2017-08-19 15:58:00 by Adam Ciarcinski | Files touched by this commit (1)
Log message:
Depend on py-typing only for Python < 3.6
   2017-07-03 19:43:36 by Adam Ciarcinski | Files touched by this commit (2)
Log message:
Release 1.6.3:

Features added
* latex: hint that code-block continues on next page

Bugs fixed
* Failed to import sphinx.util.compat with docutils-0.14rc1
* sphinx-quickstart template is incomplete regarding use of alabaster
* 'str object' has no attribute 'filename'
* Emit wrong warnings if citation label includes hyphens
* Some warnings are not colored when using --color option
* Remove unwanted whitespace in default template
* sphinx.ext.imgmath fails to convert SVG images if project directory
  name contains spaces
* Fix color handling in make mode's help command
* use of self.env.warn in sphinx extension fails
* production lists apply smart quotes transform since Sphinx 1.6.1
* latex: fix ``\sphinxbfcode`` swallows initial space of argument
* Quotes in auto-documented class attributes should be straight quotes
  in PDF output
* LaTeX figure floated to next page sometimes leaves extra vertical
* duplicated footnotes raises IndexError
* Failure of deprecation warning mechanism of
* Bogus warnings for "citation not referenced" for cross-file citations
* Don't download images when builders not supported images
* Remote image URIs without filename break builders not supported remote
* command line messages are translated unintentionally with ``language``
* make checking ``epub_uid`` strict
* Fix about box drawing characters for PDF output
* autosummary could not find methods
* Emit error if ``latex_documents`` contains non-unicode string in py2
   2017-05-29 18:00:27 by Adam Ciarcinski | Files touched by this commit (2)
Log message:
Release 1.6.2:

Incompatible changes
* 3789: Do not require typing module for python>=3.5

Bugs fixed
* 3754: HTML builder crashes if HTML theme appends own stylesheets
* 3756: epub: Entity ‘mdash’ not defined
* 3758: Sphinx crashed if logs are emitted in conf.py
* 3755: incorrectly warns about dedent with literalinclude
* 3742: RTD PDF builds of Sphinx own docs are missing an index entry in the \ 
bookmarks and table of contents. This is rtfd/readthedocs.org-2857 issue, a \ 
workaround is obtained using some extra LaTeX code in Sphinx’s own conf.py
* 3770: Build fails when a “code-block” has the option emphasize-lines \ 
and the number indicated is higher than the number of lines
* 3774: Incremental HTML building broken when using citations
* 3772: ‘str object’ has no attribute ‘filename’
* 3763: got epubcheck validations error if epub_cover is set
* 3779: ‘ImportError’ in sphinx.ext.autodoc due to broken \ 
‘sys.meta_path’. Thanks to Tatiana Tereshchenko.
* 3796: env.resolve_references() crashes when non-document node given
* 3803: Sphinx crashes with invalid PO files
* 3791: PDF “continued on next page” for long tables isn’t \ 
* 3788: smartquotes emits warnings for unsupported languages
* 3807: latex Makefile for make latexpdf is only for unixen
* 3781: double hyphens in option directive are compiled as endashes
* 3817: latex builder raises AttributeError
   2017-05-18 22:09:06 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
Release 1.6.1 (released May 16, 2017)



* (updated) latex output is tested with Ubuntu trusty's texlive packages (Feb.
  2014) and earlier tex installations may not be fully compliant, particularly
  regarding Unicode engines xelatex and lualatex
* (added) latexmk is required for ``make latexpdf`` on Unix-like platforms

Incompatible changes


* 1061, 2336, 3235: Now generation of autosummary doesn't contain imported
  members by default. Thanks to Luc Saffre.
* LaTeX ``\includegraphics`` command isn't overloaded: only \ 
  has the custom code to fit image to available width if oversized.
* The subclasses of ``sphinx.domains.Index`` should override ``generate()``
  method.  The default implementation raises NotImplementedError
* LaTeX positioned long tables horizontally centered, and short ones
  flushed left (no text flow around table.) The position now defaults to center in
  both cases, and it will obey Docutils 0.13 ``:align:`` option (refs 3415, 3377)
* option directive also allows all punctuations for the option name (refs: 3366)
* 3413: if :rst:dir:`literalinclude`'s ``:start-after:`` is used, make ``:lines:``
  relative (refs 3412)
* ``literalinclude`` directive does not allow the combination of ``:diff:``
  option and other options (refs: 3416)
* LuaLaTeX engine uses ``fontspec`` like XeLaTeX. It is advised ``latex_engine
  = 'lualatex'`` be used only on up-to-date TeX installs (refs 3070, 3466)
* :confval:`latex_keep_old_macro_names` default value has been changed from
  ``True`` to ``False``. This means that some LaTeX macros for styling are
  by default defined only with ``\sphinx..`` prefixed names. (refs: 3429)
* Footer "Continued on next page" of LaTeX longtable's now not framed \ 
(refs: 3497)
* 3529: The arguments of ``BuildEnvironment.__init__`` is changed
* 3082: Use latexmk for pdf (and dvi) targets (Unix-like platforms only)
* 3558: Emit warnings if footnotes and citations are not referenced.  The
  warnings can be suppressed by ``suppress_warnings``.
* latex made available (non documented) colour macros from a file distributed
  with pdftex engine for Plain TeX. This is removed in order to provide better
  support for multiple TeX engines. Only interface from ``color`` or
  ``xcolor`` packages should be used by extensions of Sphinx latex writer.
   2017-04-06 10:51:43 by Adam Ciarcinski | Files touched by this commit (3)
Log message:
Release 1.5.5

Bugs fixed
* 3597: python domain raises UnboundLocalError if invalid name given
* 3599: Move to new Mathjax CDN
   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.