./textproc/py-sphinx, Python documentation generator

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


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

Required to build:
[pkgtools/cwrappers]

Master sites:

SHA1: 3caa8c2d3f9b283e32df259baee885c0340c5d02
RMD160: ec3c0ca4039f124214ec733532adda9254fe95d9
Filesize: 4613.401 KB

Version history: (Expand)


CVS history: (Expand)


   2018-08-06 22:13:47 by Adam Ciarcinski | Files touched by this commit (1)
Log message:
py-sphinx: do not depend on py-sphinx-rtd-theme, but the other way around
   2018-07-19 11:07:52 by Adam Ciarcinski | Files touched by this commit (2)
Log message:
py-sphinx: 1.7.6

Release 1.7.6:

Bugs fixed
* LaTeX \sphinxupquote{} breaks in Russian
* sphinx.testing uses deprecated pytest API; Node.get_marker(name)
* crashed when recommonmark.AutoStrictify is enabled
* latex: crashed with docutils package provided by Debian/Ubuntu
* latex: a label for table is vanished if table does not have a caption
* crashed with numbered toctree
* C, render empty argument lists for macros.
* C++, fix lookup of full template specializations with no template arguments.
* C++, fix assertion on missing references in global scope when using
  intersphinx. Thanks to Alan M. Carroll.
* autodoc: crashed by Form Feed Character
* autodoc: loses the first staticmethod parameter for old styled classes
* quickstart: Typing Ctrl-U clears the whole of line
* html: "relations" sidebar is not shown by default
* latex: curly braces in index entries are not handled correctly
* epub: Wrong internal href fragment links
* apidoc: Interface of sphinx.apidoc:main() has changed
* PDF builds of French projects have issues with XeTeX
* napoleon raises RuntimeError with python 3.7
* sphinx-build: Interface of sphinx:main() has changed
* sphinx-build: sphinx.cmd.build.main() refers sys.argv instead of given
  argument
* autosummary: warning is emitted when the first line of docstring ends
  with literal notation
* autosummary: warnings of autosummary indicates wrong location
* autodoc: crashed on inspecting dict like object which does not support
  sorting
* autodoc: Enum argument missing if it shares value with another
* py domain: rtype field could not handle "None" as a type
* LaTeX: indexing of terms containing @, !, or " fails
* html: crashes if copying static files are failed
* autodoc: Fix formatting type annotations for tuples with more than two
  arguments
* i18n: crashed by auto-symbol footnote references
* autosummary: module summary has been broken when it starts with heading
   2018-05-29 09:13:07 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.7.5

Release 1.7.5:

Bugs fixed
* html search: Upper characters problem in any other languages
* apidoc: some subpackage is ignored if sibling subpackage contains a module \ 
starting with underscore
* i18n doesn’t handle node.title correctly tat used for contents, topic, \ 
admonition, table and section.
* i18n: literal blocks in bullet list are not translated
* C++, raised TypeError on duplicate declaration.
* C++, properly parse expr roles and give better error messages when (escaped) \ 
line breaks are present.
* C++, properly use desc_addname nodes for prefixes of names.
* C++, parse pack expansions in function calls.
* * links on search page are broken when using dirhtml builder
* autodoc: constructor method should not have return annotation
* latex: deeply nested enumerated list which is beginning with non-1 causes \ 
LaTeX engine crashed
* latex: shorthandoff is not set up for Brazil locale
* i18n: Ignore dot-directories like .git/ in LC_MESSAGES/
* py domain: type field could not handle “None” as a type
* latex: Incorrect escaping of curly braces in index entries
* autodoc: Failed to extract document from a subclass of the class on mocked module
* latex: glossary directive adds whitespace to each item
* latex: Explicit labels on code blocks are duplicated
* node.asdom() crashes if toctree has :numbered: option
* autodoc: Parsing error when using dataclasses without default values
* autodoc: crashed when handler for autodoc-skip-member raises an error
* autodoc: crashed when subclass of mocked class are processed by napoleon module
* sphinx-build crashes when error log contains a “%” character
   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

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:
Deprecated
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 \ 
changed
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