in the classic theme to fit with
- * #1815: Fix linkcheck does not raise an exception if warniserror set
- to true and link is broken
- * #2197: Fix slightly cryptic error message for missing index.rst
- file
- * #1894: Unlisted phony targets in quickstart Makefile
- * #2125: Fix unifies behavior of collapsed fields (GroupedField and
- TypedField)
- * #1408: Check latex_logo validity before copying
- * #771: Fix latex output doesn’t set tocdepth
- * #1820: On Windows, console coloring is broken with colorama version
- 0.3.3. Now sphinx use colorama>=0.3.5 to avoid this problem.
- * #2072: Fix footnotes in chapter-titles do not appear in PDF output
- * #1580: Fix paragraphs in longtable don’t work in Latex output
- * #1366: Fix centered image not centered in latex
- * #1860: Fix man page using :samp: with braces - font doesn’t reset
- * #1610: Sphinx crashes in japanese indexing in some systems
- * Fix Sphinx crashes if mecab initialization failed
- * #2160: Fix broken TOC of PDFs if section includes an image
- * #2172: Fix dysfunctional admonition [53]py@lightbox in sphinx.sty.
- Thanks to jfbu.
- * #2198,#2205: make gettext generate broken msgid for definition
- lists.
- * #2062: Escape characters in doctests are treated incorrectly with
- Python 2.
- * #2225: Fix if the option does not begin with dash, linking is not
- performed
- * #2226: Fix math is not HTML-encoded when :nowrap: is given (jsmath,
- mathjax)
- * #1601, #2220: ‘any’ role breaks extended domains behavior. Affected
- extensions doesn’t support resolve_any_xref and resolve_xref
- returns problematic node instead of None. sphinxcontrib-httpdomain
- is one of them.
- * #2229: Fix no warning is given for unknown options
-
--------------------------------------------------------------------
-Wed Dec 9 16:41:19 UTC 2015 - michael@stroeder.com
-
-- Update to 1.3.3
-- Updated project url in .spec file
-- Aligned version in BuildRequires: python-Pygments >= 2.0 with
- Requires line
-
-Release 1.3.3 (released Dec 2, 2015)
-====================================
-
-Bugs fixed
-----------
-
-* #2012: Fix exception occurred if ``numfig_format`` is invalid
-* #2142: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js`` for
- source distribution on PyPI.
-* #2148: Error while building devhelp target with non-ASCII document.
-
-
-Release 1.3.2 (released Nov 29, 2015)
-=====================================
-
-Features added
---------------
-
-* #1935: Make "numfig_format" overridable in latex_elements.
-
-Bugs fixed
-----------
-
-* #1976: Avoid "2.0" version of Babel because it doesn't work with Windows environment.
-* Add a "default.css" stylesheet (which imports "classic.css") for compatibility.
-* #1788: graphviz extension raises exception when caption option is present.
-* #1789: ``:pyobject:`` option of ``literalinclude`` directive includes following
- lines after class definitions
-* #1790: ``literalinclude`` strips empty lines at the head and tail
-* #1802: load plugin themes automatically when theme.conf use it as 'inherit'. Thanks to
- Takayuki Hirai.
-* #1794: custom theme extended from alabaster or sphinx_rtd_theme can't find base theme.
-* #1834: compatibility for docutils-0.13: handle_io_errors keyword argument for
- docutils.io.FileInput cause TypeError.
-* #1823: '.' as for sphinx-apidoc cause an unfriendly error. Now '.'
- is converted to absolute path automatically.
-* Fix a crash when setting up extensions which do not support metadata.
-* #1784: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js``
-* #1822, #1892: Fix regression for #1061. autosummary can't generate doc for imported
- members since sphinx-1.3b3. Thanks to Eric Larson.
-* #1793, #1819: "see also" misses a linebreak in text output. Thanks to Takayuki Hirai.
-* #1780, #1866: "make text" shows "class" keyword twice. Thanks to Takayuki
- Hirai.
-* #1871: Fix for LaTeX output of tables with one column and multirows.
-* Work around the lack of the HTMLParserError exception in Python 3.5.
-* #1949: Use ``safe_getattr`` in the coverage builder to avoid aborting with
- descriptors that have custom behavior.
-* #1915: Do not generate smart quotes in doc field type annotations.
-* #1796: On py3, automated .mo building caused UnicodeDecodeError.
-* #1923: Use babel features only if the babel latex element is nonempty.
-* #1942: Fix a KeyError in websupport.
-* #1903: Fix strange id generation for glossary terms.
-* #1796, On py3, automated .mo building cause UnicodeDecodeError
-* Fix: ``make text`` will crush if a definition list item has more than 1 classifiers as:
-* #1796: On py3, automated .mo building cause UnicodeDecodeError
-* ``make text`` will crush if a definition list item has more than 1 classifiers as:
-* Fixed #1855: make gettext generates broken po file for definition lists with classifier.
- ``term : classifier1 : classifier2``.
-* #1855: make gettext generates broken po file for definition lists with classifier.
-* #1869: Fix problems when dealing with files containing non-ASCII characters. Thanks to
- Marvin Schmidt.
-* #1798: Fix building LaTeX with references in titles.
-* #1725: On py2 environment, doctest with using non-ASCII characters causes
- ``'ascii' codec can't decode byte`` exception.
-* #1540: Fix RuntimeError with circular referenced toctree
-* #1983: i18n translation feature breaks references which uses section name.
-* #1990: Use caption of toctree to title of \tableofcontents in LaTeX
-* #1987: Fix ampersand is ignored in ``:menuselection:`` and ``:guilabel:`` on LaTeX builder
-* #1994: More supporting non-standard parser (like recommonmark parser) for Translation and
- WebSupport feature. Now node.rawsource is fall backed to node.astext() during docutils
- transforming.
-* On Py2 environment, conf.py that is generated by sphinx-quickstart should have u prefixed
- config value for 'version' and 'release'.
-* #2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will raise
- UnicodeEncodeError.
-* #1974: UnboundLocalError: local variable 'domain' referenced before assignment when
- using `any` role and `sphinx.ext.intersphinx` in same time.
-* #2121: multiple words search doesn't find pages when words across on the page title and
- the page content.
-* #1884, #1885: plug-in html themes cannot inherit another plug-in theme. Thanks to
- Suzumizaki.
-* #1818: `sphinx.ext.todo` directive generates broken html class attribute as
- 'admonition-' when :confval:`language` is specified with non-ASCII linguistic area like
- 'ru' or 'ja'. To fix this, now ``todo`` directive can use ```:class:`` option.
-* #2140: Fix footnotes in table has broken in LaTeX
-* #2127: MecabBinder for html searching feature doesn't work with Python 3.
- Thanks to Tomoko Uchida.
-
--------------------------------------------------------------------
-Wed Sep 16 13:16:01 UTC 2015 - toddrme2178@gmail.com
-
-- Don't buildrequires latex-related stuff.
-
--------------------------------------------------------------------
-Fri Sep 4 13:27:51 UTC 2015 - toddrme2178@gmail.com
-
-- Split latex-related stuff into its own subpackage so we can
- depend on the necessary latex components.
-
--------------------------------------------------------------------
-Wed Jul 29 13:18:28 UTC 2015 - hpj@urpla.net
-
-- Be explicit about six version requirements
-
--------------------------------------------------------------------
-Mon Jul 27 09:03:41 UTC 2015 - seife+obs@b1-systems.com
-
-- fix build on CentOS/RHEL by conditionalizing Recommends: tag
-- add #!BuildIgnore: texinfo to work around CentOS-7 project config
-
--------------------------------------------------------------------
-Mon Jun 29 14:07:26 UTC 2015 - toddrme2178@gmail.com
-
-- Fix directory for man update-alternatives
-- Suggests are poorly-supported in openSUSE so use Recommends
-
--------------------------------------------------------------------
-Mon Apr 13 17:17:57 UTC 2015 - alarrosa@suse.com
-
-- Added python-six as a requirement, not only as build requirement
-
--------------------------------------------------------------------
-Thu Apr 9 02:29:40 UTC 2015 - termim@gmail.com
-
-- Update to 1.3.1
- + Bugs fixed
- * see http://sphinx-doc.org/changes.html#release-1-3-1-released-mar-17-2015
- for complete list of fixed bugs
-
-- additional dependencies required by 1.3.1
- + python-Babel
- + python-alabaster
- + python-snowballstemmer
- + python-sphinx_rtdtheme
- + python-mock
- + python-six
-
-- Update to 1.3
- + Incompatible changes
- * Roles ref, term and menusel now don’t generate emphasis nodes
- anymore. If you want to keep italic style, adapt your stylesheet.
- * Role numref uses %s as special character to indicate position of
- figure numbers instead # symbol.
- * Dependency requirement updates: docutils 0.11, Pygments 2.0
- * The gettext_enables config value has been renamed to
- gettext_additional_targets.
- * #1735: Use https://doc.python.org/ instead of http protocol. It was
- used for sphinx.ext.intersphinx and some documentation.
- * update bundled ez_setup.py for setuptools-7.0 that requires Python
- 2.6 or later.
- * Dropped support for Python 2.5, 3.1 and 3.2.
- * Dropped support for docutils versions up to 0.9.
- * Removed the sphinx.ext.oldcmarkup extension.
- * The deprecated config values exclude_trees, exclude_dirnames and
- unused_docs have been removed.
- * A new node, sphinx.addnodes.literal_strong, has been added, for text
- that should appear literally (i.e. no smart quotes) in strong
- font. Custom writers will have to be adapted to handle this node.
- * PR#269, #1476: replace tag by . User customized
- stylesheets should be updated If the css contain some styles for tt>
- tag. Thanks to Takeshi Komiya.
- * #1543: templates_path is automatically added to exclude_patterns to
- avoid reading autosummary rst templates in the templates directory.
- * Custom domains should implement the new Domain.resolve_any_xref
- method to make the any role work properly.
- * gettext builder: gettext doesn’t emit uuid information to generated
- pot files by default. Please set True to gettext_uuid to emit uuid
- information. Additionally, if the python-levenshtein 3rd-party package is
- installed, it will improve the calculation time.
- * gettext builder: disable extracting/apply ‘index’ node by
- default. Please set ‘index’ to gettext_enables to enable extracting index
- entries.
- * PR#307: Add frame to code-block in LaTeX. Thanks to Takeshi Komiya.
- + Features added
- * Add convenience directives and roles to the C++ domain: directive
- cpp:var as alias for cpp:member, role :cpp:var as alias for :cpp:member,
- and role any for cross-reference to any C++ declaraction. #1577, #1744
- * The source_suffix config value can now be a list of multiple suffixes.
- * Add the ability to specify source parsers by source suffix with the
- source_parsers config value.
- * #1675: A new builder, AppleHelpBuilder, has been added that builds
- Apple Help Books.
- * #1346: Add new default theme;
- Add ‘alabaster’ theme.
- Add ‘sphinx_rtd_theme’ theme.
- The ‘default’ html theme has been renamed to ‘classic’. ‘default’
- is still available, however it will emit notice a recommendation that
- using new ‘alabaster’ theme.
- * Added highlight_options configuration value.
- * The language config value is now available in the HTML templates.
- * The env-updated event can now return a value, which is interpreted as
- an iterable of additional docnames that need to be rewritten.
- * #772: Support for scoped and unscoped enums in C++. Enumerators in
- unscoped enums are injected into the parent scope in addition to the enum
- scope.
- * Add todo_include_todos config option to quickstart conf file, handled
- as described in documentation.
- * HTML breadcrumb items tag has class “nav-item” and “nav-item-N” (like
- nav-item-0, 1, 2...).
- * New option sphinx-quickstart --use-make-mode for generating Makefile
- that use sphinx-build make-mode.
- * #1235: i18n: several node can be translated if it is set to
- gettext_additional_targets in conf.py. Supported nodes are:
- ‘literal-block’
- ‘doctest-block’
- ‘raw’
- ‘image’
- * #1227: Add html_scaled_image_link config option to conf.py, to
- control scaled image link.
- * #1597: Added possibility to return a new template name from
- html-page-context.
- * PR#314, #1150: Configuration values are now checked for their type. A
- warning is raised if the configured and the default value do not have the
- same type and do not share a common non-trivial base class.
- * Add support for Python 3.4.
- * Add support for docutils 0.12
- * Added sphinx.ext.napoleon extension for NumPy and Google style
- docstring support.
- * Added support for parallel reading (parsing) of source files with the
- sphinx-build -j option. Third-party extensions will need to be checked
- for compatibility and may need to be adapted if they store information in
- the build environment object. See env-merge-info.
- * Added the any role that can be used to find a cross-reference of any
- type in any domain. Custom domains should implement the new
- Domain.resolve_any_xref method to make this work properly.
- * Exception logs now contain the last 10 messages emitted by Sphinx.
- * Added support for extension versions (a string returned by setup(),
- these can be shown in the traceback log files). Version requirements for
- extensions can be specified in projects using the new needs_extensions
- config value.
- * Changing the default role within a document with the default-role
- directive is now supported.
- * PR#214: Added stemming support for 14 languages, so that the built-in
- document search can now handle these. Thanks to Shibukawa Yoshiki.
- * PR#296, PR#303, #76: numfig feature: Assign numbers to figures,
- tables and code-blocks. This feature is configured with numfig,
- numfig_secnum_depth and numfig_format. Also numref role is
- available. Thanks to Takeshi Komiya.
- * PR#202: Allow ”.” and “~” prefixed references in :param: doc fields
- for Python.
- * PR#184: Add autodoc_mock_imports, allowing to mock imports of
- external modules that need not be present when autodocumenting.
- * #925: Allow list-typed config values to be provided on the command
- line, like -D key=val1,val2.
- * #668: Allow line numbering of code-block and literalinclude
- directives to start at an arbitrary line number, with a new lineno-start
- option.
- * PR#172, PR#266: The code-block and literalinclude directives now can
- have a caption option that shows a filename before the code in the
- output. Thanks to Nasimul Haque, Takeshi Komiya.
- * Prompt for the document language in sphinx-quickstart.
- * PR#217: Added config values to suppress UUID and location information
- in generated gettext catalogs.
- * PR#236, #1456: apidoc: Add a -M option to put module documentation
- before submodule documentation. Thanks to Wes Turner and Luc Saffre.
- * #1434: Provide non-minified JS files for jquery.js and underscore.js
- to clarify the source of the minified files.
- * PR#252, #1291: Windows color console support. Thanks to meu31.
- * PR#255: When generating latex references, also insert latex
- target/anchor for the ids defined on the node. Thanks to Olivier
- Heurtier.
- * PR#229: Allow registration of other translators. Thanks to Russell
- Sim.
- * Add app.set_translator() API to register or override a Docutils
- translator class like html_translator_class.
- * PR#267, #1134: add ‘diff’ parameter to literalinclude. Thanks to
- Richard Wall and WAKAYAMA shirou.
- * PR#272: Added ‘bizstyle’ theme. Thanks to Shoji KUMAGAI.
- * Automatically compile *.mo files from *.po files when
- gettext_auto_build is True (default) and *.po is newer than *.mo file.
- * #623: sphinx.ext.viewcode supports imported function/class aliases.
- * PR#275: sphinx.ext.intersphinx supports multiple target for the
- inventory. Thanks to Brigitta Sipocz.
- * PR#261: Added the env-before-read-docs event that can be connected to
- modify the order of documents before they are read by the environment.
- * #1284: Program options documented with option can now start with +.
- * PR#291: The caption of code-block is recognised as a title of ref
- target. Thanks to Takeshi Komiya.
- * PR#298: Add new API: add_latex_package(). Thanks to Takeshi Komiya.
- * #1344: add gettext_enables to enable extracting ‘index’ to gettext
- catalog output / applying translation catalog to generated
- documentation.
- * PR#301, #1583: Allow the line numbering of the directive
- literalinclude to match that of the included file, using a new
- lineno-match option. Thanks to Jeppe Pihl.
- * PR#299: add various options to sphinx-quickstart. Quiet mode option
- --quiet will skips wizard mode. Thanks to WAKAYAMA shirou.
- * #1623: Return types specified with :rtype: are now turned into links
- if possible.
- + Bugs fixed
- * see http://sphinx-doc.org/changes.html#release-1-3-released-mar-10-2015
- for complete list of fixed bugs
-
--------------------------------------------------------------------
-Tue Sep 9 16:14:01 UTC 2014 - toddrme2178@gmail.com
-
-- Update to 1.2.3:
- + Features added
- * #1518: `sphinx-apidoc` command now have a `--version` option to show version
- information and exit
- * New locales: Hebrew, European Portuguese, Vietnamese.
- + Bugs fixed
- * #636: Keep straight single quotes in literal blocks in the LaTeX build.
- * #1419: Generated i18n sphinx.js files are missing message catalog entries
- from '.js_t' and '.html'. The issue was introduced from Sphinx-1.1
- * #1363: Fix i18n: missing python domain's cross-references with currentmodule
- directive or currentclass directive.
- * #1444: autosummary does not create the description from attributes docstring.
- * #1457: In python3 environment, make linkcheck cause "Can't convert 'bytes'
- object to str implicitly" error when link target url has a hash part.
- Thanks to Jorge_C.
- * #1467: Exception on Python3 if nonexistent method is specified by automethod
- * #1441: autosummary can't handle nested classes correctly.
- * #1499: With non-callable `setup` in a conf.py, now sphinx-build emits
- user-friendly error message.
- * #1502: In autodoc, fix display of parameter defaults containing backslashes.
- * #1226: autodoc, autosummary: importing setup.py by automodule will invoke
- setup process and execute `sys.exit()`. Now sphinx avoids SystemExit
- exception and emits warnings without unexpected termination.
- * #1503: py:function directive generate incorrectly signature when specifying
- a default parameter with an empty list `[]`. Thanks to Geert Jansen.
- * #1508: Non-ASCII filename raise exception on make singlehtml, latex, man,
- texinfo and changes.
- * #1531: On Python3 environment, docutils.conf with 'source_link=true' in the
- general section cause type error.
- * PR#270, #1533: Non-ASCII docstring cause UnicodeDecodeError when uses with
- inheritance-diagram directive. Thanks to WAKAYAMA shirou.
- * PR#281, PR#282, #1509: TODO extension not compatible with websupport. Thanks
- to Takeshi Komiya.
- * #1477: gettext does not extract nodes.line in a table or list.
- * #1544: `make text` generate wrong table when it has empty table cells.
- * #1522: Footnotes from table get displayed twice in LaTeX. This problem has
- been appeared from Sphinx-1.2.1 by #949.
- * #508: Sphinx every time exit with zero when is invoked from setup.py command.
- ex. `python setup.py build_sphinx -b doctest` return zero even if doctest
- failed.
-
--------------------------------------------------------------------
-Thu Mar 6 12:50:16 UTC 2014 - mcihar@suse.cz
-
-- Update to 1.2.2:
- - PR#211: When checking for existence of the html_logo file, check the full
- relative path and not the basename.
- - PR#212: Fix traceback with autodoc and __init__ methods without docstring.
- - PR#213: Fix a missing import in the setup command.
- - #1357: Option names documented by option are now again allowed to not start
- with a dash or slash, and referencing them will work correctly.
- - #1358: Fix handling of image paths outside of the source directory when
- using the “wildcard” style reference.
- - #1374: Fix for autosummary generating overly-long summaries if first line
- doesn’t end with a period.
- - #1383: Fix Python 2.5 compatibility of sphinx-apidoc.
- - #1391: Actually prevent using “pngmath” and “mathjax” extensions at the
- same time in sphinx-quickstart.
- - #1386: Fix bug preventing more than one theme being added by the entry
- point mechanism.
- - #1370: Ignore “toctree” nodes in text writer, instead of raising.
- - #1364: Fix ‘make gettext’ fails when the ‘.. todolist::’ directive is
- present.
- - #1367: Fix a change of PR#96 that break
- sphinx.util.docfields.Field.make_field interface/behavior for item argument
- usage.
-
--------------------------------------------------------------------
-Mon Feb 10 15:08:45 UTC 2014 - speilicke@suse.com
-
-- Update to version 1.2.1
- + See CHANGES
-- Fix update-alternatives usage
-- Removed sphinx-setup_command_unicode.patch (upstream)
-
--------------------------------------------------------------------
-Mon Nov 18 09:05:53 UTC 2013 - speilicke@suse.com
-
-- Fix %preun update-alternatives, used wrong master
-
--------------------------------------------------------------------
-Fri Nov 15 12:17:12 UTC 2013 - speilicke@suse.com
-
-- Only ghost /etc/alternatives on 12.3 or newer
-
--------------------------------------------------------------------
-Wed Nov 13 14:54:09 UTC 2013 - speilicke@suse.com
-
-- Add sphinx-setup_command_unicode.patch: Backport of
- https://bitbucket.org/birkenfeld/sphinx/pull-request/193/
-
--------------------------------------------------------------------
-Wed Nov 6 08:10:01 UTC 2013 - speilicke@suse.com
-
-- Updateo version 1.2b3:
- + The Sphinx error log files will now include a list of the loaded extensions
- for help in debugging.
- + PR#154: Remove "sphinx" prefix from LaTeX class name except 'sphinxmanual'
- and 'sphinxhowto'. Now you can use your custom document class without
- 'sphinx' prefix. Thanks to Erik B.
- + #1265: Fix i18n: crash when translating a section name that is pointed to from
- a named target.
- + A wrong condition broke the search feature on first page that is usually
- index.rst. This issue was introduced in 1.2b1.
- + #703: When Sphinx can't decode filenames with non-ASCII characters, Sphinx now
- catches UnicodeError and will continue if possible instead of raising the
- exception.
-- Changes from version 1.2b2 and prior:
- + See CHANGES file
-- Own /etc/alternatives/sphinx-* by ghosting (update-alternatives)
-- Dropped sphinx-docutils-0.10.patch (merged upstream)
-
--------------------------------------------------------------------
-Thu Oct 24 11:14:54 UTC 2013 - speilicke@suse.com
-
-- Require python-setuptools instead of distribute (upstreams merged)
-
--------------------------------------------------------------------
-Thu Jul 18 09:15:10 UTC 2013 - speilicke@suse.com
-
-- Drop runtime req on python-distribute
-
--------------------------------------------------------------------
-Tue Jul 9 14:16:18 UTC 2013 - dmueller@suse.com
-
-- add sphinx-docutils-0.10.patch:
- * add support for docutils 0.10
-
--------------------------------------------------------------------
-Thu May 16 10:33:17 UTC 2013 - speilicke@suse.com
-
-- Fix update-alternatives and support upgrade from previous versions
-
--------------------------------------------------------------------
-Tue Apr 30 14:38:24 UTC 2013 - speilicke@suse.com
-
-- Apply update-alternatives for binaries and man-pages
-
--------------------------------------------------------------------
-Tue Nov 20 11:42:44 UTC 2012 - saschpe@suse.de
-
-- Run testsuite
-- Build and install man-pages
-
--------------------------------------------------------------------
-Thu Nov 15 05:29:16 UTC 2012 - saschpe@suse.de
-
-- Revert last "locale" change, it was a false positive
-
--------------------------------------------------------------------
-Tue Nov 6 00:24:32 UTC 2012 - saschpe@suse.de
-
-- Remove obsolete SUSE version checks
-- Don't package locale files twice
-
--------------------------------------------------------------------
-Wed May 23 16:02:17 UTC 2012 - highwaystar.ru@gmail.com
-
-- python3 package added
-
--------------------------------------------------------------------
-Wed May 23 12:59:54 UTC 2012 - saschpe@suse.de
-
-- Update to version 1.1.13:
- * PR#40: Fix safe_repr function to decode bytestrings with non-ASCII
- characters correctly.
- * PR#37: Allow configuring sphinx-apidoc via SPHINX_APIDOC_OPTIONS.
- * PR#34: Restore Python 2.4 compatibility.
- * PR#36: Make the "bibliography to TOC" fix in LaTeX output specific to
- the document class.
- * #695: When the highlight language "python" is specified explicitly,
- do not try to parse the code to recognize non-Python snippets.
- * #859: Fix exception under certain circumstances when not finding
- appropriate objects to link to.
- * #860: Do not crash when encountering invalid doctest examples, just
- emit a warning.
- * #864: Fix crash with some settings of :confval:modindex_common_prefix.
- * #862: Fix handling of -D and -A options on Python 3.
- * #851: Recognize and warn about circular toctrees, instead of running
- into recursion errors.
- * #853: Restore compatibility with docutils trunk.
- * #852: Fix HtmlHelp index entry links again.
- * #854: Fix inheritance_diagram raising attribute errors on builtins.
- * #832: Fix crashes when putting comments or lone terms in a glossary.
- * #834, #818: Fix HTML help language/encoding mapping for all Sphinx
- supported languages.
- * #844: Fix crashes when dealing with Unicode output in doctest extension.
- * #831: Provide --project flag in setup_command as advertised.
- * #875: Fix reading config files under Python 3.
- * #876: Fix quickstart test under Python 3.
- * #870: Fix spurious KeyErrors when removing documents.
- * #892: Fix single-HTML builder misbehaving with the master document in a
- subdirectory.
- * #873: Fix assertion errors with empty only directives.
- * #816: Fix encoding issues in the Qt help builder.
-
--------------------------------------------------------------------
-Thu Nov 10 11:05:21 UTC 2011 - saschpe@suse.de
-
-- Update to version 1.1.2:
- * #809: Include custom fixers in the source distribution.
-- Changes from version 1.1.1:
- * #791: Fix QtHelp, DevHelp and HtmlHelp index entry links.
- * #792: Include "sphinx-apidoc" in the source distribution.
- * #797: Don't crash on a misformatted glossary.
- * #801: Make intersphinx work properly without SSL support.
- * #805: Make the Sphinx.add_index_to_domain method work correctly.
- * #780: Fix Python 2.5 compatibility.
-
--------------------------------------------------------------------
-Thu Sep 22 10:58:02 UTC 2011 - saschpe@suse.de
-
-- Require python-docutils instead of docutils
-- Change license to BSD-2-Clause (SPDX style, according to LICENSE)
-
--------------------------------------------------------------------
-Wed Aug 31 13:59:59 UTC 2011 - saschpe@suse.de
-
-- Corrected buildrequires/requires:
- * python-jinja2 is now python-Jinja2
- * python-pygments is now python-Pygments
-
--------------------------------------------------------------------
-Tue Jul 12 09:59:25 UTC 2011 - mcihar@suse.cz
-
-- add python-distribute to Requires, it is needed to run sphinx-build
-
--------------------------------------------------------------------
-Sun Jul 3 11:31:27 UTC 2011 - saschpe@gmx.de
-
-- Renamed to 'python-Sphinx', obsoletes 'python-sphinx'
-- Update to version 1.0.7:
- * #347: Fix wrong generation of directives of static methods in
- autosummary.
- * #599: Import PIL as from PIL import Image.
- * #558: Fix longtables with captions in LaTeX output.
- * Make token references work as hyperlinks again in LaTeX output.
- * #572: Show warnings by default when reference labels cannot be
- found.
- * #536: Include line number when complaining about missing reference
- targets in nitpicky mode.
- * #590: Fix inline display of graphviz diagrams in LaTeX output.
- * #589: Build using app.build() in setup command.
- * Fix a bug in the inheritance diagram exception that caused base
- classes to be skipped if one of them is a builtin.
- * Fix general index links for C++ domain objects.
- * #332: Make admonition boundaries in LaTeX output visible.
- * #573: Fix KeyErrors occurring on rebuild after removing a file.
- * Fix a traceback when removing files with globbed toctrees.
- * If an autodoc object cannot be imported, always re-read the
- document containing the directive on next build.
- * If an autodoc object cannot be imported, show the full traceback
- of the import error.
- * Fix a bug where the removal of download files and images wasn't
- noticed.
- * #571: Implement ~ cross-reference prefix for the C domain.
- * Fix regression of LaTeX output with the fix of #556.
- * #568: Fix lookup of class attribute documentation on descriptors
- so that comment documentation now works.
- * Fix traceback with only directives preceded by targets.
- * Fix tracebacks occurring for duplicate C++ domain objects.
- * Fix JavaScript domain links to objects with $ in their name.
-- Spec file cleanup:
- * Use fdupes and %find_lang
- * Removed authors from description
- * Make doc package on require %{version}, not %{release}
-
--------------------------------------------------------------------
-Wed Jan 12 09:36:17 UTC 2011 - saschpe@suse.de
-
-- Spec file cleanup
- * correct doc package group, no dupes
- * added rpmlintrc file
-- Update to 1.0.6
- * #581: Fix traceback in Python domain for empty cross-reference
- targets.
- * #283: Fix literal block display issues on Chrome browsers.
- * #383, #148: Support sorting a limited range of accented
- characters in the general index and the glossary.
- * #570: Try decoding -D and -A command-line arguments with
- the locale's preferred encoding.
- * #528: Observe locale_dirs when looking for the JS
- translations file.
- * #574: Add special code for better support of Japanese documents
- in the LaTeX builder.
- * Regression of #77: If there is only one parameter given with
- :param: markup, the bullet list is now suppressed again.
- * #556: Fix missing paragraph breaks in LaTeX output in certain
- situations.
- * #567: Emit the autodoc-process-docstring event even for objects
- without a docstring so that it can add content.
- * #565: In the LaTeX builder, not only literal blocks require
- different table handling, but also quite a few other list-like
- block elements.
- * #515: Fix tracebacks in the viewcode extension for Python objects
- that do not have a valid signature.
- * Fix strange reportings of line numbers for warnings generated
- from autodoc-included docstrings, due to different behavior
- depending on docutils version.
- * Several fixes to the C++ domain.
-
--------------------------------------------------------------------
-Mon Jan 3 12:04:29 UTC 2011 - nix@opensuse.org
-
-- Update to 1.0.5
-
--------------------------------------------------------------------
-Wed Sep 8 12:35:13 UTC 2010 - nix@opensuse.org
-
-- Update to 1.0.3
-
--------------------------------------------------------------------
-Mon Apr 26 14:34:11 UTC 2010 - nix@opensuse.org
-
-- Update to 0.6.5
-
--------------------------------------------------------------------
-Tue Aug 11 10:53:47 CEST 2009 - cfarrell@suse.de
-
-- Update to 0.6.2 and split docs into separate package
-
--------------------------------------------------------------------
-Fri Jun 5 21:54:31 CEST 2009 - poeml@suse.de
-
-- initial package (0.6.1)
-
diff --git a/python-Sphinx-doc.spec b/python-Sphinx-doc.spec
deleted file mode 100644
index c2d81f5..0000000
--- a/python-Sphinx-doc.spec
+++ /dev/null
@@ -1,163 +0,0 @@
-#
-# spec file for package python-Sphinx-doc
-#
-# Copyright (c) 2019 SUSE LINUX GmbH, Nuernberg, Germany.
-#
-# All modifications and additions to the file contributed by third parties
-# remain the property of their copyright owners, unless otherwise agreed
-# upon. The license for this file, and modifications and additions to the
-# file, is the same license as for the pristine package itself (unless the
-# license for the pristine package is not an Open Source License, in which
-# case the license is the MIT License). An "Open Source License" is a
-# license that conforms to the Open Source Definition (Version 1.9)
-# published by the Open Source Initiative.
-
-# Please submit bugfixes or comments via https://bugs.opensuse.org/
-#
-
-
-%{?!python_module:%define python_module() python-%{**} python3-%{**}}
-%if 0%{?suse_version} != 1315
-%bcond_without latex
-%else
-%bcond_with latex
-%endif
-Name: python-Sphinx-doc
-Version: 1.8.4
-Release: 0
-Summary: Documentation for python-Sphinx
-License: BSD-2-Clause
-Group: Documentation/Other
-URL: http://sphinx-doc.org
-Source: https://files.pythonhosted.org/packages/source/S/Sphinx/Sphinx-%{version}.tar.gz
-Patch1: disable-test.patch
-BuildRequires: %{python_module Sphinx = %version}
-BuildRequires: %{python_module html5lib}
-BuildRequires: %{python_module mock}
-BuildRequires: %{python_module pytest}
-BuildRequires: ImageMagick
-BuildRequires: fdupes
-BuildRequires: python-rpm-macros
-BuildRequires: python3-mypy
-BuildRequires: python3-typed-ast
-Recommends: %{name}-html = %{version}
-BuildArch: noarch
-%if %{with latex}
-BuildRequires: python3-Sphinx-latex
-%endif
-%python_subpackages
-
-%description
-Sphinx is a tool that facilitates creating documentation for Python
-projects (or other documents consisting of multiple reStructuredText
-sources). It was originally created for the Python documentation, and
-supports Python project documentation well, but C/C++ is likewise
-supported.
-
-Sphinx uses reStructuredText as its markup language. Sphinx draws from
-the parsing and translating suite, the Docutils.
-
-This package contains the documentation for Sphinx.
-
-%package man
-Summary: Man files for python-Sphinx
-Group: Documentation/Man
-Requires: %{name}-man-common = %{version}
-Requires: python-Sphinx = %{version}
-Requires(post): update-alternatives
-Requires(postun): update-alternatives
-
-%description man
-Sphinx is a tool that facilitates creating documentation for Python
-projects (or other documents consisting of multiple reStructuredText
-sources).
-
-This package contains the manual pages for the Sphinx executables.
-
-%package -n %{name}-html
-Summary: HTML Documentation for python-Sphinx
-Group: Documentation/HTML
-Provides: %{python_module Sphinx-doc-html = %{version}}
-
-%description -n %{name}-html
-Sphinx is a tool that facilitates creating documentation for Python
-projects (or other documents consisting of multiple reStructuredText
-sources).
-
-This package contains the HTML documentation for Sphinx.
-
-%package -n %{name}-man-common
-Summary: Man files for python-Sphinx - python-independent versions
-Group: Documentation/Man
-Provides: %{python_module Sphinx-doc-man-common = %{version}}
-
-%description -n %{name}-man-common
-Sphinx is a tool that facilitates creating documentation for Python
-projects (or other documents consisting of multiple reStructuredText
-sources).
-
-This package contains the Python version-independent manual pages for the
-Sphinx executables.
-
-%prep
-%setup -q -n Sphinx-%{version}
-%patch1 -p1
-
-%build
-# build documentation
-%{_python_use_flavor python3}
-
-mkdir build.doc
-
-python3 setup.py build_sphinx && rm build/sphinx/html/.buildinfo
-python3 setup.py build_sphinx -b man
-
-mv build/sphinx/{html,man} build.doc/
-
-%install
-install -d %{buildroot}%{_docdir}/python-Sphinx/
-install -d %{buildroot}%{_mandir}/man1/
-
-mv build.doc/html %{buildroot}%{_docdir}/python-Sphinx/
-
-mv build.doc/man/sphinx-all.1 %{buildroot}%{_mandir}/man1/sphinx-all.1
-mv build.doc/man/sphinx-apidoc.1 %{buildroot}%{_mandir}/man1/sphinx-apidoc.1
-mv build.doc/man/sphinx-build.1 %{buildroot}%{_mandir}/man1/sphinx-build.1
-mv build.doc/man/sphinx-quickstart.1 %{buildroot}%{_mandir}/man1/sphinx-quickstart.1
-
-%python_clone %{buildroot}%{_mandir}/man1/sphinx-all.1
-%python_clone %{buildroot}%{_mandir}/man1/sphinx-apidoc.1
-%python_clone %{buildroot}%{_mandir}/man1/sphinx-build.1
-%python_clone %{buildroot}%{_mandir}/man1/sphinx-quickstart.1
-
-%check
-export LANG="en_US.UTF-8"
-%python_exec -m pytest tests -k "not linkcheck" -v
-
-%files %{python_files}
-%license LICENSE
-%doc AUTHORS EXAMPLES
-
-%files %{python_files man}
-%license LICENSE
-%doc AUTHORS
-%{_mandir}/man1/sphinx-all-%{python_bin_suffix}.1%{?ext_man}
-%{_mandir}/man1/sphinx-apidoc-%{python_bin_suffix}.1%{?ext_man}
-%{_mandir}/man1/sphinx-build-%{python_bin_suffix}.1%{?ext_man}
-%{_mandir}/man1/sphinx-quickstart-%{python_bin_suffix}.1%{?ext_man}
-
-%files -n %{name}-html
-%license LICENSE
-%doc AUTHORS
-%dir %{_docdir}/python-Sphinx/
-%{_docdir}/python-Sphinx/html/
-
-%files -n %{name}-man-common
-%license LICENSE
-%doc AUTHORS
-%{_mandir}/man1/sphinx-all.1%{?ext_man}
-%{_mandir}/man1/sphinx-apidoc.1%{?ext_man}
-%{_mandir}/man1/sphinx-build.1%{?ext_man}
-%{_mandir}/man1/sphinx-quickstart.1%{?ext_man}
-
-%changelog
diff --git a/python-Sphinx.changes b/python-Sphinx.changes
index 2b8d772..7258aa4 100644
--- a/python-Sphinx.changes
+++ b/python-Sphinx.changes
@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Wed Mar 6 16:28:12 CET 2019 - Matej Cepl
+
+- Rewrite the package to multibuild. Remove python-Sphinx-doc*.
+- Fix %check to make tests passing.
+
-------------------------------------------------------------------
Tue Mar 5 10:17:45 UTC 2019 - Thomas Bechtold
diff --git a/python-Sphinx.spec b/python-Sphinx.spec
index 0f50364..4ac1589 100644
--- a/python-Sphinx.spec
+++ b/python-Sphinx.spec
@@ -23,7 +23,15 @@
%else
%bcond_with latex
%endif
-Name: python-Sphinx
+%global flavor @BUILD_FLAVOR@%{nil}
+%if "%{flavor}" == "test"
+%define psuffix -test
+%bcond_without test
+%else
+%define psuffix %{nil}
+%bcond_with test
+%endif
+Name: python-Sphinx%{psuffix}
Version: 1.8.4
Release: 0
Summary: Python documentation generator
@@ -40,7 +48,7 @@ BuildRequires: python-rpm-macros
#!BuildIgnore: texinfo
Requires: python-Babel >= 1.3
Requires: python-Jinja2 >= 2.3
-Requires: python-Pygments >= 2.0
+Requires: python-Pygments >= 2.1
Requires: python-alabaster >= 0.7
Requires: python-docutils >= 0.11
Requires: python-imagesize
@@ -52,8 +60,18 @@ Requires: python-sphinxcontrib-websupport
Requires(post): update-alternatives
Requires(postun): update-alternatives
BuildArch: noarch
+%if %{with test}
+BuildRequires: %{python_module Sphinx = %{version}}
+BuildRequires: %{python_module html5lib}
+BuildRequires: %{python_module mock}
+BuildRequires: %{python_module pytest}
+BuildRequires: %{python_module sphinxcontrib-websupport}
+BuildRequires: ImageMagick
+BuildRequires: python3-mypy
+BuildRequires: python3-typed-ast
+%endif
%if 0%{?suse_version} >= 1000 || 0%{?fedora_version} >= 24
-Recommends: %{name}-doc-man
+Recommends: python-Sphinx-doc-man
Recommends: python-SQLAlchemy >= 0.9
Recommends: python-Whoosh >= 2.0
%endif
@@ -66,9 +84,6 @@ Requires: python-typing
Requires: python-typing
%endif
%endif
-%if 0%{?suse_version}
-Recommends: python-rst2pdf
-%endif
%ifpython2
Obsoletes: %{oldpython}-sphinx < %{version}
Provides: %{oldpython}-sphinx = %{version}
@@ -85,10 +100,20 @@ supported.
Sphinx uses reStructuredText as its markup language. Sphinx draws from
the parsing and translating suite, the Docutils.
+%package -n python-Sphinx-lang
+Summary: Translations for package python-Sphinx
+Group: System/Localization
+Requires: python-Sphinx = %{version}
+
+%description -n python-Sphinx-lang
+Provides translations for the "python-Sphinx" package.
+
%package latex
Summary: Sphinx packages for LaTeX
Group: Productivity/Publishing/TeX/Base
-Requires: %{name} = %{version}
+BuildRequires: %{python_module base}
+Requires: python-Sphinx = %{version}
+Requires: texlive-gnu-freefont
Requires: texlive-latex
Requires: texlive-metafont
Requires: texlive-pdftex
@@ -161,7 +186,52 @@ Sphinx is a tool that facilitates creating documentation for Python
projects (or other documents consisting of multiple reStructuredText
sources).
-This package contains the LaTeX components for %{name}.
+This package contains the LaTeX components for python-Sphinx.
+
+%package -n python-Sphinx-doc
+Summary: Man files for python-Sphinx
+Group: Documentation/Other
+Requires: python-Sphinx = %{version}
+
+%description -n python-Sphinx-doc
+Sphinx is a tool that facilitates creating documentation for Python
+projects (or other documents consisting of multiple reStructuredText
+sources). It was originally created for the Python documentation, and
+supports Python project documentation well, but C/C++ is likewise
+supported.
+
+Sphinx uses reStructuredText as its markup language. Sphinx draws from
+the parsing and translating suite, the Docutils.
+
+This package contains the documentation for Sphinx.
+
+%package -n python-Sphinx-doc-man
+Summary: Man files for python-Sphinx
+Group: Documentation/Man
+Requires: python-Sphinx = %{version}
+Requires: python-Sphinx-man-common = %{version}
+Requires(post): update-alternatives
+Requires(postun): update-alternatives
+Obsoletes: %{python_module Sphinx-doc-man-common <= %{version}}
+
+%description -n python-Sphinx-doc-man
+Sphinx is a tool that facilitates creating documentation for Python
+projects (or other documents consisting of multiple reStructuredText
+sources).
+
+This package contains the manual pages for the Sphinx executables.
+
+%package -n python-Sphinx-doc-html
+Summary: HTML Documentation for python-Sphinx
+Group: Documentation/HTML
+Provides: %{python_module Sphinx-doc-html = %{version}}
+
+%description -n python-Sphinx-doc-html
+Sphinx is a tool that facilitates creating documentation for Python
+projects (or other documents consisting of multiple reStructuredText
+sources).
+
+This package contains the HTML documentation for Sphinx.
%prep
%setup -q -n Sphinx-%{version}
@@ -172,7 +242,17 @@ sed -i 's/\r$//' sphinx/themes/basic/static/jquery.js # Fix wrong end-of-line en
%build
%python_build
+%if %{with test}
+mkdir build.doc
+
+python3 setup.py build_sphinx && rm build/sphinx/html/.buildinfo
+python3 setup.py build_sphinx -b man
+
+mv build/sphinx/{html,man} build.doc/
+%endif
+
%install
+%if ! %{with test}
%python_install
%python_clone -a %{buildroot}%{_bindir}/sphinx-apidoc
@@ -183,15 +263,53 @@ sed -i 's/\r$//' sphinx/themes/basic/static/jquery.js # Fix wrong end-of-line en
%python_expand mkdir -p %{buildroot}%{$python_sitelib}/sphinxcontrib
%python_expand %fdupes %{buildroot}%{$python_sitelib}
+# Prepare lang lists
+mkdir -p %{buildroot}%{_datadir}/locale/
+rm -rf %{buildroot}%{python2_sitelib}/sphinx/locale/*
+ls %{buildroot}%{python3_sitelib}/sphinx/locale
+find %{buildroot}%{python3_sitelib}/sphinx/locale -type f -a \( -name \*.p\* -o -name \*.js \) -print -delete
+mv -fvt %{buildroot}%{_datadir}/locale/ %{buildroot}%{python3_sitelib}/sphinx/locale/*
+rm -rf %{buildroot}%{python3_sitelib}/sphinx/locale
+%find_lang sphinx
+
+%else
+mkdir -p %{buildroot}%{_docdir}/python-Sphinx/
+mv build.doc/html %{buildroot}%{_docdir}/python-Sphinx/
+
+mkdir -p %{buildroot}%{_mandir}/man1
+mv build.doc/man/sphinx-all.1 %{buildroot}%{_mandir}/man1/sphinx-all.1
+mv build.doc/man/sphinx-apidoc.1 %{buildroot}%{_mandir}/man1/sphinx-apidoc.1
+mv build.doc/man/sphinx-build.1 %{buildroot}%{_mandir}/man1/sphinx-build.1
+mv build.doc/man/sphinx-quickstart.1 %{buildroot}%{_mandir}/man1/sphinx-quickstart.1
+
+%python_clone %{buildroot}%{_mandir}/man1/sphinx-all.1
+%python_clone %{buildroot}%{_mandir}/man1/sphinx-apidoc.1
+%python_clone %{buildroot}%{_mandir}/man1/sphinx-build.1
+%python_clone %{buildroot}%{_mandir}/man1/sphinx-quickstart.1
+
+%endif
+
+%if ! %{with test}
%post
%{python_install_alternative sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart}
%postun
%python_uninstall_alternative sphinx-apidoc
+%endif
+
+%check
+%if %{with test}
+export LC_ALL="C.utf8"
+%{python_expand export PYTHONPATH=$PYTHONPATH:%{buildroot}%{$python_sitelib}
+py.test-%{$python_bin_suffix} --ignore=_build.python3 --ignore=_build.python2 -k 'not linkcheck' -v tests
+# $python -mpytest --ignore=_build.python3 --ignore=_build.python2 -k 'not linkcheck' -v tests
+}
+%endif
%files %{python_files}
%license LICENSE
%doc AUTHORS CHANGES README.rst
+%if ! %{with test}
%python_alternative %{_bindir}/sphinx-apidoc
%python_alternative %{_bindir}/sphinx-autogen
%python_alternative %{_bindir}/sphinx-build
@@ -203,12 +321,36 @@ sed -i 's/\r$//' sphinx/themes/basic/static/jquery.js # Fix wrong end-of-line en
%{python_sitelib}/Sphinx-%{version}-py*.egg-info
%dir %{python_sitelib}/sphinxcontrib
+%files -n python-Sphinx-lang -f sphinx.lang
+
# Requirements are not available on SLES
%if %{with latex}
%files %{python_files latex}
%license LICENSE
%doc AUTHORS
%{python_sitelib}/sphinx/texinputs/
+%endif
+%endif
+
+%if %{with test}
+%files -n python-Sphinx-doc-man
+%license LICENSE
+%doc AUTHORS
+%{_mandir}/man1/sphinx-all-*.1%{?ext_man}
+%{_mandir}/man1/sphinx-apidoc-*.1%{?ext_man}
+%{_mandir}/man1/sphinx-build-*.1%{?ext_man}
+%{_mandir}/man1/sphinx-quickstart-*.1%{?ext_man}
+%{_mandir}/man1/sphinx-all.1%{?ext_man}
+%{_mandir}/man1/sphinx-apidoc.1%{?ext_man}
+%{_mandir}/man1/sphinx-build.1%{?ext_man}
+%{_mandir}/man1/sphinx-quickstart.1%{?ext_man}
+
+%files -n python-Sphinx-doc-html
+%license LICENSE
+%doc AUTHORS
+%dir %{_docdir}/python-Sphinx/
+%{_docdir}/python-Sphinx/html/
+
%endif
%changelog