./textproc/py-sphinx, Python documentation generator

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


Branch: CURRENT, Version: 1.8.5nb2, Package name: py37-sphinx-1.8.5nb2, 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] [devel/py-requests] [lang/py-six] [textproc/py-snowballstemmer] [textproc/py-alabaster] [graphics/py-imagesize] [devel/py-packaging] [textproc/py-sphinxcontrib-websupport] [lang/python37]

Required to build:
[pkgtools/cwrappers]

Master sites:

SHA1: 93e715cb5d16d981698caa2d54b3b58596798f5d
RMD160: a7a38523976288c13a8a7e5bf4a81367db9af462
Filesize: 5621.662 KB

Version history: (Expand)


CVS history: (Expand)


   2019-08-24 06:48:02 by Ryo ONODERA | Files touched by this commit (1) | Package updated
Log message:
Revert wrong workaround and require py-packaging>=19.1nb1 explicitly

Bump PKGREVISION.
From wiz@, thank you.
   2019-08-23 15:18:52 by Ryo ONODERA | Files touched by this commit (1) | Package updated
Log message:
Fix runtime error when building docs in mail/notmuch, bump PKGREVISION
   2019-05-02 11:27:09 by Adam Ciarcinski | Files touched by this commit (5)
Log message:
Forget about Python 3.4
   2019-03-10 14:36:02 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.8.5

1.8.5:
Bugs fixed
* LaTeX: Remove extraneous space after author names on PDF title page
* LaTeX: A cross reference to definition list does not work
* LaTeX: TypeError is raised when invalid latex_elements given
* LaTeX: images having a target are concatenated to next line
* LaTeX: images having a target are not aligned even if specified
* imgconverter: Including multipage PDF fails
* autodoc: autofunction emits a warning for method objects
* graphviz: Ensure the graphviz filenames are reproducible
* doctest: skipif option may remove the code block from documentation
* :name: option for math directive causes a crash
* intersphinx: ValueError on failure reporting
* changes: Fix UnboundLocalError when any module found
   2019-02-05 13:54:23 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.8.4

Release 1.8.4:

Bugs fixed
* latex: no bold checkmark (✔) available.
* with the documentation language set to Chinese, English words could not
  be searched.
* LaTeX: user numfig_format is stripped of spaces and may cause
  build failure
* C++, fix hyperlinks for declarations involving east cv-qualifiers.
* C++, fix duplicate declaration error on function templates with constraints
  in the return type.
* C++, parse unary right fold expressions and binary fold expressions.
* pycode could not handle egg files on windows
* KeyError: 'DOCUTILSCONFIG' when running build
* LaTeX: PDF build broken by inclusion of image taller than page height
  in an admonition
* "make html" does not read and build "po" files in \ 
"locale" dir
* :scale: image option may break PDF build if image in an admonition
* LaTeX: modified PDF layout since September 2018 TeXLive update of
  :file:parskip.sty
* LaTeX: duplicated labels are generated for sections
* versionadded directive causes crash with Python 3.5.0
* autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7
* texinfo: a section title . is not allowed
   2018-12-31 13:10:44 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-sphinx: updated to 1.8.3

Release 1.8.3:

Features added
* LaTeX: it is possible to insert custom material to appear on back of title
  page, see discussion of 'maketitle' key of :confval:latex_elements
  ('manual' docclass only)

Bugs fixed
* mathjax: Use CDN URL for "latest" version by default
* html search does not work with some 3rd party themes
* LaTeX, caption package incompatibility since Sphinx 1.6
* autodoc: incremental build is broken when builtin modules are imported
* qthelp: index.html missing in QtHelp
* linkcheck: crashes for a hyperlink containing multibyte character
* DOC: Fix some mistakes in :doc:/latex
* LaTeX: sphinxVerbatim requires explicit "hllines" set-up since 1.6.6
* C++, fix parsing of floating point literals.
* C++, fix assertion in partial builds with duplicates.
* quickstart: sphinx-quickstart fails when $LC_ALL is empty
* Default conf.py is not PEP8-compliant
* LaTeX: document class \maketitle is overwritten with no
  possibility to use original meaning in place of Sphinx custom one
* apidoc: wrong help for --tocfile
* todo: crashed if todo is defined in TextElement
* htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files
* htmlhelp: broken .hhk file generated when title contains a double quote
   2018-11-13 12:30:40 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.8.2

Release 1.8.2:

Incompatible changes
* Do not include MathJax.js and jsmath.js unless it is really needed

Features added
* Show appropriate deprecation warnings

Bugs fixed
* latex: enumerated list causes a crash with recommonmark
* sphinx-build fails to build docs w/ Python < 3.5.2
* latex: wrong \label positioning for figures with a legend
* C++, fix assertion when a symbol is declared more than twice.
* gettext: crashed with broken template
* csv-table directive with file option in included file is broken
* autodoc: unable to find type hints for a functools.partial
* autodoc: unable to find type hints for unresolvable Forward references
* incompatible math_block node has been generated
* Fix ensuredir() in case of pre-existing file
* graphviz Correctly deal with non-existing static dir
* i18n: multiple footnote_references referring same footnote causes
  duplicated node_ids
* latex: footnote_references generated by extension causes LaTeX builder
  crashed
* make all-pdf fails with old xindy version
* quickstart: --no-batchfile isn't honored
* texinfo: multiline rubrics are broken
* texinfo: multiline citations are broken
   2018-09-24 10:21:50 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx: updated to 1.8.1

Release 1.8.1:

Incompatible changes
LaTeX \pagestyle commands have been moved to the LaTeX template. No changes in \ 
PDF, except possibly if \sphinxtableofcontents, which contained them, had been \ 
customized in conf.py.

Bugs fixed
* Incorrect default path for sphinx-build -d/doctrees files
* autodoc emits deprecation warning for autodoc_default_flags
* lambda object causes PicklingError on storing environment
* Sphinx fails to build with syntax error in Python 2.7.5
* add latexpdf to make.bat for non make-mode
* Autodoc does not work with enum subclasses with properties/methods
* autodoc: crashed on modules importing eggs
* latex: ImportError: cannot import name ‘DEFAULT_SETTINGS’
* autodoc: autofunction emits a warning for callable objects
* Fix TypeError in error message when override is prohibited
* PDF builds of ‘howto’ documents have no page numbers
* mathbase: math_role and MathDirective was disappeared in 1.8.0
* latex: Index has disappeared from PDF for Japanese documents
* py domain: :type: field can’t process :term: references
* py domain: TypeError has been raised for class attribute