./textproc/py-sphinx, Python documentation generator

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

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

Required to build:

Master sites:

SHA1: 0ad169f2f2a6f7c6ddf01a845ece03afd9a18968
RMD160: a05ba966e79e0312e037380eb89363767ca11442
Filesize: 4611.727 KB

Version history: (Expand)

CVS history: (Expand)

   2018-04-26 09:49:29 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.7.4

Release 1.7.4:
Bugs fixed
* domains: Crashed with duplicated objects
* latex: sphinx.writers.latex causes recusrive import
   2018-04-25 10:08:21 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-sphinx: updated to 1.7.3

Bugs fixed
* autodoc loses the first staticmethod parameter
* autosummary: too wide two column tables in PDF builds
* Latex customization via _templates/longtable.tex_t is broken
* imgconverter: confused by convert.exe of Windows
* On windows, Sphinx crashed when drives of srcdir and outdir are different
* autodoc ignores type annotated variables
* wrong URLs on warning messages
* latex: latex_show_urls assigns incorrect footnote numbers if hyperlinks exists \ 
inside substitutions
* latex with class memoir Error: Font command \sf is not supported
* latex: too slow in proportion to number of auto numbered footnotes
* htmlhelp: The entries in .hhp file is not ordered
* toctree directive tries to glob for URL having query_string
* html search: Upper characters problem in German
* latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX
* duplicated labels detector does not work well in parallel build
* Crashed with extension which returns invalid metadata
   2018-03-23 08:42:08 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-sphinx: updated to 1.7.2

Release 1.7.2:

Incompatible changes
* apidoc: folders with an empty __init__.py are no longer excluded from TOC

Bugs fixed
* sphinx.build_main and sphinx.make_main throw NameError
* autosummary emits meaningless warnings
* autodoc: crashed when invalid options given
* pydomain: always strip parenthesis if empty
* autosummary: unexpectedly strips docstrings containing “i.e.”
* viewcode: Misplaced <div> in viewcode html output
* Don’t require numfig to use :numref: on sections
* Option clash for package textcomp
* Sphinx does not work with python 3.5.0 and 3.5.1
* Generation PDF file with TexLive on Windows, file not found error
* vertical space before equation in latex
* message when an image is mismatched for builder is not clear
* Incomplete localization strings in Polish and Chinese
* Sphinx crashes when error is happens in rendering HTML pages
* Error to download remote images having long URL
* sphinx/pycode/__init__.py raises AttributeError
* qthelp builder should htmlescape keywords
* epub: Fix docTitle elements of toc.ncx is not escaped
* apidoc: Subpackage not in toc (introduced in 1.6.6) now fixed
   2018-02-25 22:39:21 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-sphinx: updated to 1.7.1

Release 1.7.1:
4623: sphinx.build_main() is deprecated. Use sphinx.cmd.build.build_main() instead.
autosummary: The interface of sphinx.ext.autosummary.get_documenter() has been \ 
changed (Since 1.7.0)
4664: sphinx.ext.intersphinx.debug() is deprecated. Use \ 
sphinx.ext.intersphinx.inspect_main() instead.

Bugs fixed
4608: epub: Invalid meta tag is generated
4260: autodoc: keyword only argument separator is not disappeared if it is \ 
appeared at top of the argument list
4622: epub: epub_scheme does not effect to content.opf
4627: graphviz: Fit graphviz images to page
4617: quickstart: PROJECT_DIR argument is required
4623: sphinx.build_main no longer exists in 1.7.0
4615: The argument of sphinx.build has been changed in 1.7.0
autosummary: The interface of sphinx.ext.autosummary.get_documenter() has been \ 
4630: Have order on msgids in sphinx.pot deterministic
4563: autosummary: Incorrect end of line punctuation detection
4577: Enumerated sublists with explicit start with wrong number
4641: A external link in TOC cannot contain “?” with :glob: option
C++, add missing parsing of explicit casts and typeid in expression parsing.
C++, add missing parsing of this in expression parsing.
4655: Fix incomplete localization strings in Polish
4653: Fix error reporting for parameterless ImportErrors
4664: Reading objects.inv fails again
4662: any refs with term targets crash when an ambiguity is encountered
   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