./textproc/py-sphinx, Python documentation generator

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

Branch: CURRENT, Version: 1.6.7, Package name: py27-sphinx-1.6.7, 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] [devel/py-typing] [textproc/py-sphinxcontrib-websupport]

Required to build:
[converters/py-simplejson] [textproc/py-html5lib] [devel/py-nose] [devel/py-mock] [pkgtools/cwrappers]

Master sites:

SHA1: 92a9c4c594b7ca7b779fe69c99a71f9d42c07682
RMD160: 6f5c72bb3baf5ffa898463df9a5d222df4c0475d
Filesize: 4582.196 KB

Version history: (Expand)

CVS history: (Expand)

   2018-02-05 14:10:59 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-sphinx: updated to 1.6.7

Release 1.6.7:

Bugs fixed
* 1922: html search: Upper characters problem in French
* 4412: Updated jQuery version from 3.1.0 to 3.2.1
* 4438: math: math with labels with whitespace cause html error
* 2437: make full reference for classes, aliased with "alias of"
* 4434: pure numbers as link targets produce warning
* 4477: Build fails after building specific files
* 4449: apidoc: include "empty" packages that contain modules
* 3917: citation labels are tranformed to ellipsis
* 4501: graphviz: epub3 validation error caused if graph is not clickable
* 4514: graphviz: workaround for wrong map ID which graphviz generates
* 4525: autosectionlabel does not support parallel build
* 3953: Do not raise warning when there is a working intersphinx inventory
* 4487: math: ValueError is raised on parallel build. Thanks to jschueller.
* 2372: autosummary: invalid signatures are shown for type annotated functions
* 3942: html: table is not aligned to center even if :align: center
   2018-01-09 21:05:45 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.6.6

Release 1.6.6:

Features added
* autodoc: Sort dictionary keys when possible
* VerbatimHighlightColor is a new
  :ref:LaTeX 'sphinxsetup' <latexsphinxsetup> key
* Easier customizability of LaTeX macros involved in rendering of code-blocks
* Show traceback if conf.py raises an exception
* Add :confval:smartquotes to disable smart quotes through conf.py
* Add :confval:smartquotes_action and :confval:smartquotes_excludes

Bugs fixed
* sphinx-apidoc: Don't generate references to non-existing files in TOC
* latex: reST label between paragraphs loses paragraph break
* html: Apply fixFirefoxAnchorBug only under Firefox
* napoleon depends on autodoc, but users need to load it manually
* automodule fails to document a class attribute
* C++: properly link class reference to class from inside constructor
* PDF build broken by Unicode U+2116 NUMERO SIGN character
* PDF output: Pygments error highlighting increases line spacing in code blocks
* Support :emphasize-lines: in PDF output
* Sphinx crashes with pickling error when run with multiple processes and
  remote image
* Respect the quiet flag in sphinx-quickstart
* Race conditions when creating output directory
* For PDF 'howto' documents, latex_toplevel_sectioning='part' generates
  \chapter commands
* Two todolist directives break sphinx-1.6.5
* Fix links to external option docs with intersphinx
* Private members not documented without :undoc-members:
   2017-11-16 08:46:12 by Thomas Klausner | Files touched by this commit (1)
Log message:
py-sphinx: remove py-typing dependency for py35

python-3.5 includes this module.
   2017-10-24 09:42:12 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.6.5

Release 1.6.5:

Features added
* 4107: Make searchtools.js compatible with pre-Sphinx1.5 templates
* 4112: Don't override the smart_quotes setting if it was already set
* 4125: Display reference texts of original and translated passages on
  i18n warning message
* 4147: Include the exception when logging PO/MO file read/write

Bugs fixed
* 4085: Failed PDF build from image in parsed-literal using ``:align:`` option
* 4100: Remove debug print from autodoc extension
* 3987: Changing theme from alabaster causes HTML build to fail
* 4096: C++, don't crash when using the wrong role type. Thanks to mitya57.
* 4070, 4111: crashes when the warning message contains format strings (again)
* 4108: Search word highlighting breaks SVG images
* 3692: Unable to build HTML if writing .buildinfo failed
* 4152: HTML writer crashes if a field list is placed on top of the document
* 4063: Sphinx crashes when labeling directive ``.. todolist::``
* 4134: [doc] :file:`docutils.conf` is not documented explicitly
* 4169: Chinese language doesn't trigger Chinese search automatically
* 1020: ext.todo todolist not linking to the page in pdflatex
* 3965: New quickstart generates wrong SPHINXBUILD in Makefile
* 3739: ``:module:`` option is ignored at content of pyobjects
* 4149: Documentation: Help choosing :confval:`latex_engine`
* 4090: [doc] :confval:`latex_additional_files` with extra LaTeX macros should
  not use ``.tex`` extension
* Failed to convert reST parser error to warning
   2017-09-28 13:18:24 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-sphinx: update to 1.6.4

Release 1.6.4:

Features added
* 3926: Add autodoc_warningiserror to suppress the behavior of -W option during \ 
importing target modules on autodoc

Bugs fixed
* 3924: docname lost after dynamically parsing RST in extension
* 3946: Typo in sphinx.sty (this was a bug with no effect in default context)
* pep: and :rfc: does not supports default-role directive (refs: 3960)
* 3960: default_role = ‘guilabel’ not functioning
* Missing texinputs_win/Makefile to be used in latexpdf builder on windows.
* 4026: nature: Fix macOS Safari scrollbar color
* 3877: Fix for C++ multiline signatures.
* 4006: Fix crash on parallel build
* 3969: private instance attributes causes AttributeError
* 4041: C++, remove extra name linking in function pointers.
* 4038: C, add missing documentation of member role.
* 4044: An empty multicolumn cell causes extra row height in PDF output
* 4049: Fix typo in output of sphinx-build -h
* 4062: hashlib.sha1() must take bytes, not unicode on Python 3
* Avoid indent after index entries in latex (refs: 4066)
* 4070: crashes when the warning message contains format strings
* 4067: Return non-zero exit status when make subprocess fails
* 4055: graphviz: the :align: option does not work for SVG output
* 4055: graphviz: the :align: center option does not work for latex output
* 4051: warn() function for HTML theme outputs ‘None’ string
   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