head 1.2; access; symbols pkgsrc-2023Q4:1.2.0.34 pkgsrc-2023Q4-base:1.2 pkgsrc-2023Q3:1.2.0.32 pkgsrc-2023Q3-base:1.2 pkgsrc-2023Q2:1.2.0.30 pkgsrc-2023Q2-base:1.2 pkgsrc-2023Q1:1.2.0.28 pkgsrc-2023Q1-base:1.2 pkgsrc-2022Q4:1.2.0.26 pkgsrc-2022Q4-base:1.2 pkgsrc-2022Q3:1.2.0.24 pkgsrc-2022Q3-base:1.2 pkgsrc-2022Q2:1.2.0.22 pkgsrc-2022Q2-base:1.2 pkgsrc-2022Q1:1.2.0.20 pkgsrc-2022Q1-base:1.2 pkgsrc-2021Q4:1.2.0.18 pkgsrc-2021Q4-base:1.2 pkgsrc-2021Q3:1.2.0.16 pkgsrc-2021Q3-base:1.2 pkgsrc-2021Q2:1.2.0.14 pkgsrc-2021Q2-base:1.2 pkgsrc-2021Q1:1.2.0.12 pkgsrc-2021Q1-base:1.2 pkgsrc-2020Q4:1.2.0.10 pkgsrc-2020Q4-base:1.2 pkgsrc-2020Q3:1.2.0.8 pkgsrc-2020Q3-base:1.2 pkgsrc-2020Q2:1.2.0.6 pkgsrc-2020Q2-base:1.2 pkgsrc-2020Q1:1.2.0.2 pkgsrc-2020Q1-base:1.2 pkgsrc-2019Q4:1.2.0.4 pkgsrc-2019Q4-base:1.2 pkgsrc-2019Q3:1.1.0.40 pkgsrc-2019Q3-base:1.1 pkgsrc-2019Q2:1.1.0.38 pkgsrc-2019Q2-base:1.1 pkgsrc-2019Q1:1.1.0.36 pkgsrc-2019Q1-base:1.1 pkgsrc-2018Q4:1.1.0.34 pkgsrc-2018Q4-base:1.1 pkgsrc-2018Q3:1.1.0.32 pkgsrc-2018Q3-base:1.1 pkgsrc-2018Q2:1.1.0.30 pkgsrc-2018Q2-base:1.1 pkgsrc-2018Q1:1.1.0.28 pkgsrc-2018Q1-base:1.1 pkgsrc-2017Q4:1.1.0.26 pkgsrc-2017Q4-base:1.1 pkgsrc-2017Q3:1.1.0.24 pkgsrc-2017Q3-base:1.1 pkgsrc-2017Q2:1.1.0.20 pkgsrc-2017Q2-base:1.1 pkgsrc-2017Q1:1.1.0.18 pkgsrc-2017Q1-base:1.1 pkgsrc-2016Q4:1.1.0.16 pkgsrc-2016Q4-base:1.1 pkgsrc-2016Q3:1.1.0.14 pkgsrc-2016Q3-base:1.1 pkgsrc-2016Q2:1.1.0.12 pkgsrc-2016Q2-base:1.1 pkgsrc-2016Q1:1.1.0.10 pkgsrc-2016Q1-base:1.1 pkgsrc-2015Q4:1.1.0.8 pkgsrc-2015Q4-base:1.1 pkgsrc-2015Q3:1.1.0.6 pkgsrc-2015Q3-base:1.1 pkgsrc-2015Q2:1.1.0.4 pkgsrc-2015Q2-base:1.1 pkgsrc-2015Q1:1.1.0.2 pkgsrc-2015Q1-base:1.1; locks; strict; comment @# @; 1.2 date 2019.10.21.21.01.35; author adam; state Exp; branches; next 1.1; commitid kEqLgmRvw6cxgMHB; 1.1 date 2015.02.24.11.07.55; author markd; state Exp; branches; next ; commitid 0wO2UUzPrkmMDfby; desc @@ 1.2 log @py-sphinx: updated to 2.2.0 Release 2.2.0: Incompatible changes apidoc: template files are renamed to .rst_t html: Field lists will be styled by grid layout Deprecated¶ sphinx.domains.math.MathDomain.add_equation() sphinx.domains.math.MathDomain.get_next_equation_number() The info and warn arguments of sphinx.ext.autosummary.generate.generate_autosummary_docs() sphinx.ext.autosummary.generate._simple_info() sphinx.ext.autosummary.generate._simple_warn() sphinx.ext.todo.merge_info() sphinx.ext.todo.process_todo_nodes() sphinx.ext.todo.process_todos() sphinx.ext.todo.purge_todos() Features added * graphviz: :graphviz_dot: option is renamed to :layout: * html: emit a warning if html_static_path and html_extra_path directories are inside output directory * html: Add a label to search input for accessability purposes * apidoc: Add --templatedir option * Add override argument to app.add_autodocumenter() * imgmath: let imgmath_use_preview work also with the SVG format for images rendering inline math * LaTeX: refactor visit_enumerated_list() to use \sphinxsetlistlabels * quickstart: Use https://docs.python.org/3/ for default setting of intersphinx_mapping * sphinx-build: give reasons why rebuilded Bugs fixed py domain: duplicated warning does not point the location of source code * html: Sphinx never updates a copy of html_logo even if original file has changed * html theme: scrollbar is hard to see on classic theme and macOS * linkcheck: Consider HTTP 503 response as not an error * Make generated download links reproducible * UnboundLocalError is raised if broken extension installed * autodoc: autodoc_inherit_docstrings does not effect to __init__() and __new__() * autodoc: autodoc_member_order does not refer order of imports when 'bysource' order * autodoc: missing type annotation for variadic and keyword parameters * autodoc: Formatting issues with autodoc_typehints=’none’ * autodoc: crashed when target code contains custom method-like objects * autosummary: crashed with wrong autosummary_generate setting * autosummary: crashes without no autosummary_generate setting * LaTeX: autonumbered list can not be customized in LaTeX since Sphinx 1.8.0 * Failed to load last environment object when extension added * Invalid sort in pair index * last_updated wrongly assumes timezone as UTC * std domain: option directive registers an index entry for each comma separated option * sphinx-build: Escaped characters in error messages * doctest comments not getting trimmed since Sphinx 1.8.0 * glossary: Wrong hyperlinks are generated for non alphanumeric terms * i18n: classifiers of definition list are not translated with docutils-0.15 * DocFieldTransformer raises AttributeError when given directive is not a subclass of ObjectDescription Release 2.1.2: Bugs fixed * custom lexers fails highlighting when syntax error * info field lists are incorrectly recognized Release 2.1.1 (released Jun 10, 2019) Incompatible changes * autodoc: Stop to generate document for undocumented module variables Bugs fixed * LaTeX: admonitions of note type can get separated from immediately preceding section title by pagebreak * autodoc: crashed when autodocumenting classes with __slots__ = None * autodoc: generates docs for “optional import”ed modules as variables * autosummary: crashed when generating document of properties * napoleon: docstrings for properties are not processed * napoleon: “Unknown target name” error if variable name ends with underscore * apidoc: missing blank lines between modules Release 2.1.0: Incompatible changes Ignore filenames without file extension given to Builder.build_specific() API directly * The anchor of term in glossary directive is changed if it is consisted by non-ASCII characters * html: Centering tables by default using CSS * latex: xelatex and xeCJK are used for Chinese documents by default Sphinx.add_lexer() now takes a Lexer class instead of instance. An instance of lexers are still supported until Sphinx-3.x. Deprecated sphinx.builders.latex.LaTeXBuilder.apply_transforms() sphinx.builders._epub_base.EpubBuilder.esc() sphinx.directives.Acks sphinx.directives.Author sphinx.directives.Centered sphinx.directives.Class sphinx.directives.CodeBlock sphinx.directives.Figure sphinx.directives.HList sphinx.directives.Highlight sphinx.directives.Include sphinx.directives.Index sphinx.directives.LiteralInclude sphinx.directives.Meta sphinx.directives.Only sphinx.directives.SeeAlso sphinx.directives.TabularColumns sphinx.directives.TocTree sphinx.directives.VersionChange sphinx.domains.python.PyClassmember sphinx.domains.python.PyModulelevel sphinx.domains.std.StandardDomain._resolve_citation_xref() sphinx.domains.std.StandardDomain.note_citations() sphinx.domains.std.StandardDomain.note_citation_refs() sphinx.domains.std.StandardDomain.note_labels() sphinx.environment.NoUri sphinx.ext.apidoc.format_directive() sphinx.ext.apidoc.format_heading() sphinx.ext.apidoc.makename() sphinx.ext.autodoc.importer.MockFinder sphinx.ext.autodoc.importer.MockLoader sphinx.ext.autodoc.importer.mock() sphinx.ext.autosummary.autolink_role() sphinx.ext.imgmath.DOC_BODY sphinx.ext.imgmath.DOC_BODY_PREVIEW sphinx.ext.imgmath.DOC_HEAD sphinx.transforms.CitationReferences sphinx.transforms.SmartQuotesSkipper sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes() sphinx.util.node.find_source_node() sphinx.util.i18n.find_catalog() sphinx.util.i18n.find_catalog_files() sphinx.util.i18n.find_catalog_source_files() For more details, see deprecation APIs list. Features added Add a helper class sphinx.transforms.post_transforms.SphinxPostTransform Add helper methods PythonDomain.note_module() PythonDomain.note_object() SphinxDirective.set_source_info() * Support --keep-going with BuildDoc setup command math directive now supports :class: option todo: todo directive now supports :name: option Enable override via environment of SPHINXOPTS and SPHINXBUILD Makefile variables * autodoc: Unable to document bound instance methods exported as module functions * autodoc: autodoc_default_options now supports imported-members option * autodoc: Support coroutine * autodoc: Support abstractmethod * autodoc: Support attributes in __slots__. For dict-style __slots__, autodoc considers values as a docstring of the attribute * autodoc: Add autodoc_typehints to suppress typehints from signature * autodoc: automodule directive now handles undocumented module level variables * autosummary: Add autosummary_imported_members to display imported members on autosummary * make clean is catastrophically broken if building into ‘.’ * Support %O% environment variable in make.bat * py domain: Add :async: option to py:function directive * py domain: Add new options to py:method directive :abstractmethod: :async: :classmethod: :property: :staticmethod: rst domain: Add directive:option directive to describe the option for directive * html: Add a label to search form for accessability purposes * html: Consistent and semantic CSS for signatures * The rawsource property of production nodes now contains the full production rule * autosectionlabel: Allow suppression of warnings coverage: Support a new coverage_ignore_pyobjects option * latex: Support to build Chinese documents Bugs fixed * Inappropriate node_id has been generated by glossary directive if term is consisted by non-ASCII characters * ifconfig: contents after headings are not shown commented term in glossary directive is wrongly recognized * rst domain: rst:directive directive generates waste space * py domain: Module index (py-modindex.html) has duplicate titles * man: invalid output when doctest follows rubric * “Hyperlink target is not referenced” message is shown even if referenced * autodoc: tab_width setting of docutils has been ignored * autodoc: crashes with a plain Tuple on Python 3.6 and 3.5 * autosummary: autosummary table gets confused by complex type hints * autosummary: confused by an argument having some kind of default value Generated Makefiles lack a final EOL * extlinks: Cannot escape angle brackets in link caption * linkcheck: Send commonly used User-Agent * html search: failed to search document with haiku and scrolls themes * html search: Fix the ranking of search results * Wrong year is returned for SOURCE_DATE_EPOCH * image directive crashes by unknown image format * C++, allow 8 and 9 in hexadecimal integer literals. * Fix the string in quickstart for ‘path’ argument of parser LaTeX: Figures in admonitions produced errors Release 2.0.1: Bugs fixed LaTeX: some system labels are not translated RemovedInSphinx30Warning is marked as pending deprecation warnings are not emitted sphinx.application.CONFIG_FILENAME sphinx.builders.htmlhelp viewcode_import * C++, properly parse full xrefs that happen to have a short xref as prefix * napoleon: AttributeError is raised for raised section having references * circular import error on importing SerializingHTMLBuilder * LaTeX: ‘releasename’ setting for latex_elements is ignored * html: Search function is broken with 3rd party themes * html: HTML5Translator crashed with invalid field node * html theme: The style of field lists has changed in bizstyle theme Release 2.0.0: Dependencies 2.0.0b1 LaTeX builder now depends on TeX Live 2015 or above. LaTeX builder (with 'pdflatex' latex_engine) will process Unicode Greek letters in text (not in math mark-up) via the text font and will not escape them to math mark-up. See the discussion of the 'fontenc' key of latex_elements; such (optional) support for Greek adds, for example on Ubuntu xenial, the texlive-lang-greek and (if default font set-up is not modified) cm-super(-minimal) as additional Sphinx LaTeX requirements. LaTeX builder with latex_engine set to 'xelatex' or to 'lualatex' requires (by default) the FreeFont fonts, which in Ubuntu xenial are provided by package fonts-freefont-otf, and e.g. in Fedora 29 via package texlive-gnu-freefont. requests 2.5.0 or above The six package is no longer a dependency The sphinxcontrib-websupport package is no longer a dependency Some packages are separated to sub packages: sphinxcontrib.applehelp sphinxcontrib.devhelp sphinxcontrib.htmlhelp sphinxcontrib.jsmath sphinxcontrib.serializinghtml sphinxcontrib.qthelp Incompatible changes 2.0.0b1 Drop python 2.7 and 3.4 support Drop docutils 0.11 support Drop features and APIs deprecated in 1.7.x The default setting for master_doc is changed to 'index' which has been longly used as default of sphinx-quickstart. LaTeX: Move message resources to sphinxmessage.sty LaTeX: Stop using \captions macro for some labels LaTeX: for 'xelatex' and 'lualatex', use the FreeFont OpenType fonts as default choice LaTeX: 'xelatex' and 'lualatex' now use \small in code-blocks (due to FreeMono character width) like 'pdflatex' already did (due to Courier character width). You may need to adjust this via latex_elements 'fvset' key, in case of usage of some other OpenType fonts LaTeX: Greek letters in text are not escaped to math mode mark-up, and they will use the text font not the math font. The LGR font encoding must be added to the 'fontenc' key of latex_elements for this to work (only if it is needed by the document, of course). LaTeX: setting the language to 'en' triggered Sonny option of fncychap, now it is Bjarne to match case of no language specified. * doctest: Follow highlight_language on highlighting doctest block. As a result, they are highlighted as python3 by default. The order of argument for HTMLTranslator, HTML5Translator and ManualPageTranslator are changed LaTeX: hard-coded redefinitions of \l@@section and \l@@subsection formerly done during loading of 'manual' docclass get executed later, at time of \sphinxtableofcontents. This means that custom user definitions from LaTeX preamble now get overwritten. Use \sphinxtableofcontentshook to insert custom user definitions. See Macros. quickstart: Simplify generated conf.py * quickstart: some questions are removed. They are still able to specify via command line options websupport: unbundled from sphinx core. Please use sphinxcontrib-websupport C++, the visibility of base classes is now always rendered as present in the input. That is, private is now shown, where it was ellided before. LaTeX: graphics inclusion of oversized images rescales to not exceed the text width and height, even if width and/or height option were used. epub: epub_title defaults to the project option * All tables and figures without align option are displayed to center * html: Output HTML5 by default 2.0.0b2 texinfo: image files are copied into name-figure directory Deprecated 2.0.0b1 Support for evaluating Python 2 syntax is deprecated. This includes configuration files which should be converted to Python 3. The arguments of EpubBuilder.build_mimetype(), EpubBuilder.build_container(), EpubBuilder.bulid_content(), EpubBuilder.build_toc() and EpubBuilder.build_epub() The arguments of Epub3Builder.build_navigation_doc() The config variables html_experimental_html5_writer The encoding argument of autodoc.Documenter.get_doc(), autodoc.DocstringSignatureMixin.get_doc(), autodoc.DocstringSignatureMixin._find_signature(), and autodoc.ClassDocumenter.get_doc() are deprecated. The importer argument of sphinx.ext.autodoc.importer._MockModule The nodetype argument of sphinx.search.WordCollector. is_meta_keywords() The suffix argument of env.doc2path() is deprecated. The string style base argument of env.doc2path() is deprecated. The fallback to allow omitting the filename argument from an overridden IndexBuilder.feed() method is deprecated. sphinx.addnodes.abbreviation sphinx.application.Sphinx._setting_up_extension sphinx.builders.epub3.Epub3Builder.validate_config_value() sphinx.builders.html.SingleFileHTMLBuilder sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file() sphinx.cmd.quickstart.term_decode() sphinx.cmd.quickstart.TERM_ENCODING sphinx.config.check_unicode() sphinx.config.string_classes sphinx.domains.cpp.DefinitionError.description sphinx.domains.cpp.NoOldIdError.description sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded sphinx.ext.autodoc.importer._MockImporter sphinx.ext.autosummary.Autosummary.warn() sphinx.ext.autosummary.Autosummary.genopt sphinx.ext.autosummary.Autosummary.warnings sphinx.ext.autosummary.Autosummary.result sphinx.ext.doctest.doctest_encode() sphinx.io.SphinxBaseFileInput sphinx.io.SphinxFileInput.supported sphinx.io.SphinxRSTFileInput sphinx.registry.SphinxComponentRegistry.add_source_input() sphinx.roles.abbr_role() sphinx.roles.emph_literal_role() sphinx.roles.menusel_role() sphinx.roles.index_role() sphinx.roles.indexmarkup_role() sphinx.testing.util.remove_unicode_literal() sphinx.util.attrdict sphinx.util.force_decode() sphinx.util.get_matching_docs() sphinx.util.inspect.Parameter sphinx.util.jsonimpl sphinx.util.osutil.EEXIST sphinx.util.osutil.EINVAL sphinx.util.osutil.ENOENT sphinx.util.osutil.EPIPE sphinx.util.osutil.walk() sphinx.util.PeekableIterator sphinx.util.pycompat.NoneType sphinx.util.pycompat.TextIOWrapper sphinx.util.pycompat.UnicodeMixin sphinx.util.pycompat.htmlescape sphinx.util.pycompat.indent sphinx.util.pycompat.sys_encoding sphinx.util.pycompat.terminal_safe() sphinx.util.pycompat.u sphinx.writers.latex.ExtBabel sphinx.writers.latex.LaTeXTranslator._make_visit_admonition() sphinx.writers.latex.LaTeXTranslator.babel_defmacro() sphinx.writers.latex.LaTeXTranslator.collect_footnotes() sphinx.writers.latex.LaTeXTranslator.generate_numfig_format() sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition() sphinx.writers.text.TextTranslator._make_depart_admonition() template variables for LaTeX template logo numfig_format pageautorefname translatablestrings For more details, see deprecation APIs list. Features added 2.0.0b1 * The search results preview of generated HTML documentation is reader-friendlier: instead of showing the snippets as raw reStructuredText markup, Sphinx now renders the corresponding HTML. This means the Sphinx extension Sphinx: pretty search results is no longer necessary. Note that changes to the search function of your custom or 3rd-party HTML template might overwrite this improvement. * autodoc: Support suppress_warnings * autodoc: autodoc_default_options supports member-order * autodoc: Display readable names in type annotations for mocked objects * autodoc: autodoc_default_options accepts True as a value * autodoc: Add autodecorator directive for decorators * autosummary: Add autosummary_mock_imports to mock external libraries on importing targets * htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix * text: Support complex tables (colspan and rowspan) LaTeX: support rendering (not in math, yet) of Greek and Cyrillic Unicode letters in non-Cyrillic document even with 'pdflatex' as latex_engine * The versionadded, versionchanged and deprecated directives are now generated with their own specific CSS classes (added, changed and deprecated, respectively) in addition to the generic versionmodified class. * apidoc: Add –extensions option to sphinx-apidoc * C++, added an alias directive for inserting lists of declarations, that references existing declarations (e.g., for making a synopsis). C++: add cpp:struct to complement cpp:class. * the HTML search considers words that contain a search term of length three or longer a match. * epub: Show warning for duplicated ToC entries * Allow to omit an argument for code-block directive. If omitted, it follows highlight or highlight_language * html: Add html4_writer to use old HTML4 writer * HTML search: A placeholder for the search summary prevents search result links from changing their position when the search terminates. This makes navigating search results easier. * linkcheck also checks remote images exist * githubpages: create CNAME file for custom domains when html_baseurl set * autosectionlabel: restrict the labeled sections by new config value; autosectionlabel_maxdepth Bugs fixed 2.0.0b1 * LaTeX: writer should not translate Greek unicode, but use textgreek package * LaTeX: PDF does not build with default font config for Russian language and 'xelatex' or 'lualatex' as latex_engine * LaTeX: Greek letters in section titles disappear from PDF bookmarks * LaTeX: Unicode Greek letters in math directive break PDF build (fix requires extra set-up, see latex_elements 'textgreek' key and/or latex_engine setting) * LaTeX: should the Bjarne style of fncychap be used for English also if passed as language option? * LaTeX: (lualatex only) escaping of > by \textgreater{} is not enough as \textgreater{}\textgreater{} applies TeX-ligature LaTeX: project name is not escaped if latex_documents omitted LaTeX: authors are not shown if latex_documents omitted HTML: Invalid HTML5 file is generated for a glossary having multiple terms for one description QtHelp: OS dependent path separator is used in .qhp file HTML search: search always returns nothing when multiple search terms are used and one term is shorter than three characters 2.0.0b2 * html: Anchor links are not added to figures * html: Defer searchindex.js rather than loading it via ajax * html: Table cells and list items have large margins * linenothreshold option for highlight directive was ignored texinfo: make install-info causes syntax error texinfo: make install-info fails on macOS * texinfo: image files are not copied on make install-info * A cross reference in heading is rendered as literal * C++, fix cpp:alias problems in LaTeX (and singlehtml) * classes attribute of citation_reference node is lost AssertionError is raised when custom citation_reference node having classes attribute refers missing citation * Support code directive C++, fix parsing of braced initializers. * AttributeError is raised for old styled index nodes * inheritance_diagram: correctly describe behavior of parts option in docs, allow negative values. * i18n: Captions missing in translations for hidden TOCs 2.0.0 final * py domain: unexpected prefix is generated Testing 2.0.0b1 Stop to use SPHINX_TEST_TEMPDIR envvar 2.0.0b2 Add a helper function: sphinx.testing.restructuredtext.parse() @ text @bin/sphinx-apidoc @@PREFIX@@/bin/sphinx-apidoc-@@PYVERSSUFFIX@@ bin/sphinx-autogen @@PREFIX@@/bin/sphinx-autogen-@@PYVERSSUFFIX@@ bin/sphinx-build @@PREFIX@@/bin/sphinx-build-@@PYVERSSUFFIX@@ bin/sphinx-quickstart @@PREFIX@@/bin/sphinx-quickstart-@@PYVERSSUFFIX@@ @ 1.1 log @Use ALTERNATIVES framework to allow concurrent installation under multiple pythons. Bump PKGREVISION. @ text @d1 4 a4 4 bin/sphinx-apidoc @@PREFIX@@/bin/sphinx-apidoc@@PYVERSSUFFIX@@ bin/sphinx-autogen @@PREFIX@@/bin/sphinx-autogen@@PYVERSSUFFIX@@ bin/sphinx-build @@PREFIX@@/bin/sphinx-build@@PYVERSSUFFIX@@ bin/sphinx-quickstart @@PREFIX@@/bin/sphinx-quickstart@@PYVERSSUFFIX@@ @