From dd711a7dc786060582e6f6580572d9ae6f7c78a7 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Sat, 9 Jun 2018 13:03:38 +0200 Subject: [PATCH 001/174] Search: make a difference between fullname and dispname --- sphinx/search/__init__.py | 4 ++-- tests/test_search.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index fc55a2a45..1c5d0a848 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -331,13 +331,13 @@ class IndexBuilder(object): for domainname, domain in sorted(iteritems(self.env.domains)): for fullname, dispname, type, docname, anchor, prio in \ sorted(domain.get_objects()): - # XXX use dispname? if docname not in fn2index: continue if prio < 0: continue fullname = htmlescape(fullname) - prefix, name = rpartition(fullname, '.') + dispname = htmlescape(dispname) + prefix, name = rpartition(dispname, '.') pdict = rv.setdefault(prefix, {}) try: typeindex = otypes[domainname, type] diff --git a/tests/test_search.py b/tests/test_search.py index aa315c405..886151831 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -161,7 +161,7 @@ def test_IndexBuilder(): 'docnames': ('docname', 'docname2'), 'envversion': '1.0', 'filenames': ['filename', 'filename2'], - 'objects': {'': {'objname': (0, 0, 1, '#anchor')}}, + 'objects': {'': {'objdispname': (0, 0, 1, '#anchor')}}, 'objnames': {0: ('dummy', 'objtype', 'objtype')}, 'objtypes': {0: 'dummy:objtype'}, 'terms': {'comment': [0, 1], From 3691d6ca6418a2d1d2a7715126c158ec852d5904 Mon Sep 17 00:00:00 2001 From: Gabriel Laskar Date: Mon, 24 Apr 2017 02:49:15 +0200 Subject: [PATCH 002/174] latex writer: move ever template parts into latex.tex_t Signed-off-by: Gabriel Laskar --- sphinx/templates/latex/latex.tex_t | 4 ++++ sphinx/writers/latex.py | 8 -------- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/sphinx/templates/latex/latex.tex_t b/sphinx/templates/latex/latex.tex_t index 0ea75557f..41f517330 100644 --- a/sphinx/templates/latex/latex.tex_t +++ b/sphinx/templates/latex/latex.tex_t @@ -44,6 +44,10 @@ \newcommand{\sphinxlogo}{<%= logo %>} \renewcommand{\releasename}{<%= releasename %>} <%= makeindex %> +\begin{document} +<%= shorthandoff %> +<%= maketitle %> +<%= tableofcontents %> <%= body %> <%= atendofbody %> <%= indices %> diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index e4fdf3ca1..afde39e18 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -47,13 +47,6 @@ if False: logger = logging.getLogger(__name__) -BEGIN_DOC = r''' -\begin{document} -%(shorthandoff)s -%(maketitle)s -%(tableofcontents)s -''' - SHORTHANDOFF = r''' \ifdefined\shorthandoff \ifnum\catcode`\=\string=\active\shorthandoff{=}\fi @@ -901,7 +894,6 @@ class LaTeXTranslator(nodes.NodeVisitor): self.curfilestack.append(node.get('docname', '')) if self.first_document == 1: # the first document is all the regular content ... - self.body.append(BEGIN_DOC % self.elements) self.first_document = 0 elif self.first_document == 0: # ... and all others are the appendices From a3bfccc11febdb2bc22c93d8850a9f379f798645 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aliz=C3=A9e=20Penel?= Date: Fri, 25 May 2018 17:24:39 +0200 Subject: [PATCH 003/174] Add a test for multiple latex documents build MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Alizée Penel --- tests/roots/test-build-multiple-latex-docs/conf.py | 10 ++++++++++ tests/roots/test-build-multiple-latex-docs/file1.rst | 4 ++++ tests/roots/test-build-multiple-latex-docs/file2.rst | 4 ++++ tests/test_build_latex.py | 8 ++++++++ 4 files changed, 26 insertions(+) create mode 100644 tests/roots/test-build-multiple-latex-docs/conf.py create mode 100644 tests/roots/test-build-multiple-latex-docs/file1.rst create mode 100644 tests/roots/test-build-multiple-latex-docs/file2.rst diff --git a/tests/roots/test-build-multiple-latex-docs/conf.py b/tests/roots/test-build-multiple-latex-docs/conf.py new file mode 100644 index 000000000..002f791ee --- /dev/null +++ b/tests/roots/test-build-multiple-latex-docs/conf.py @@ -0,0 +1,10 @@ +# -*- coding: utf-8 -*- + +master_doc = 'file2' + +latex_documents = [ + ('file1', 'file1.tex', 'Multiple files building test: file1', 'Sphinx', + 'article'), + ('file2', 'file2.tex', 'Multiple files building test: file2', 'Sphinx', + 'report'), +] diff --git a/tests/roots/test-build-multiple-latex-docs/file1.rst b/tests/roots/test-build-multiple-latex-docs/file1.rst new file mode 100644 index 000000000..0613d1ec6 --- /dev/null +++ b/tests/roots/test-build-multiple-latex-docs/file1.rst @@ -0,0 +1,4 @@ +Testing multiple latex documents build +====================================== + +This is the first document. diff --git a/tests/roots/test-build-multiple-latex-docs/file2.rst b/tests/roots/test-build-multiple-latex-docs/file2.rst new file mode 100644 index 000000000..a7b15a2e8 --- /dev/null +++ b/tests/roots/test-build-multiple-latex-docs/file2.rst @@ -0,0 +1,4 @@ +Testing multiple latex documents build +====================================== + +This is the second document. diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 56c1329f7..4d4d8b9de 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -122,6 +122,14 @@ def test_build_latex_doc(app, status, warning, engine, docclass): compile_latex_document(app) +@pytest.mark.sphinx('latex', testroot='build-multiple-latex-docs') +def test_build_multiple_latex_docs(app, status, warning): + app.builder.build_all() + + assert (app.outdir / 'file1.tex').isfile() + assert (app.outdir / 'file2.tex').isfile() + + @pytest.mark.sphinx('latex') def test_writer(app, status, warning): app.builder.build_all() From a8f23b1d44b0e328f1fb71f3c4bf9e18c147b309 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aliz=C3=A9e=20Penel?= Date: Wed, 20 Jun 2018 00:36:13 +0200 Subject: [PATCH 004/174] test: check latex document beginning MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Check some commands in latex basic test: * \begin{document} * \maketitle * \sphinxtableofcontents * Add a test on shorthandoff insertion Signed-off-by: Alizée Penel --- tests/test_build_latex.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 4d4d8b9de..06a6ce9a5 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -178,11 +178,27 @@ def test_latex_basic(app, status, warning): print(result) print(status.getvalue()) print(warning.getvalue()) + assert r'\begin{document}' in result + assert r'\maketitle' in result + assert r'\sphinxtableofcontents' in result assert r'\title{The basic Sphinx documentation for testing}' in result assert r'\release{}' in result assert r'\renewcommand{\releasename}{}' in result +@pytest.mark.sphinx('latex', testroot='basic', confoverrides={'language':'de'}) +def test_latex_shorthandoff(app, status, warning): + app.builder.build_all() + result = (app.outdir / 'test.tex').text(encoding='utf8') + print(result) + print(status.getvalue()) + print(warning.getvalue()) + assert ('\\ifdefined\\shorthandoff\n' + ' \\ifnum\\catcode`\\=\\string=\\active\\shorthandoff{=}\\fi\n' + ' \\ifnum\\catcode`\\"=\\active\\shorthandoff{"}\\fi\n' + '\\fi\n' in result) + + @pytest.mark.sphinx('latex', testroot='latex-title') def test_latex_title_after_admonitions(app, status, warning): app.builder.build_all() From 4cd90a644a30e14ba4a9138f634f90b448c05cff Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Mon, 25 Jun 2018 08:03:05 +0200 Subject: [PATCH 005/174] BuildDoc: add and pass through nitpicky option This allows for using e.g. `tox -e docs -- -n` with Sphinx's own `build_sphinx` distutils command. --- sphinx/setup_command.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index c54179227..c3957fefc 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -87,9 +87,10 @@ class BuildDoc(Command): ('link-index', 'i', 'Link index.html to the master doc'), ('copyright', None, 'The copyright string'), ('pdb', None, 'Start pdb on exception'), + ('nitpicky', 'n', 'nit-picky mode, warn about all missing references'), ] boolean_options = ['fresh-env', 'all-files', 'warning-is-error', - 'link-index'] + 'link-index', 'nitpicky'] def initialize_options(self): # type: () -> None @@ -107,6 +108,7 @@ class BuildDoc(Command): self.copyright = '' self.verbosity = 0 self.traceback = False + self.nitpicky = False def _guess_source_dir(self): # type: () -> unicode @@ -174,6 +176,8 @@ class BuildDoc(Command): confoverrides['today'] = self.today if self.copyright: confoverrides['copyright'] = self.copyright + if self.nitpicky: + confoverrides['nitpicky'] = self.nitpicky for builder, builder_target_dir in self.builder_target_dirs: app = None From 94b467dbc89d2057c5435dabc6861b34b219429f Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sun, 1 Jul 2018 16:10:51 +0200 Subject: [PATCH 006/174] #4255 clarify documentation of ``startdocname`` parameters. * Relative path from source directory * Similar to ``master_doc`` in functionality --- doc/usage/configuration.rst | 58 +++++++++++++++++++++++-------------- 1 file changed, 37 insertions(+), 21 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index a0fbe641a..98cc4ab8d 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1765,20 +1765,30 @@ information. It must be a list of tuples ``(startdocname, targetname, title, author, documentclass, toctree_only)``, where the items are: - * *startdocname*: document name that is the "root" of the LaTeX file. All - documents referenced by it in TOC trees will be included in the LaTeX file - too. (If you want only one LaTeX file, use your :confval:`master_doc` - here.) - * *targetname*: file name of the LaTeX file in the output directory. - * *title*: LaTeX document title. Can be empty to use the title of the - *startdoc*. This is inserted as LaTeX markup, so special characters like a - backslash or ampersand must be represented by the proper LaTeX commands if - they are to be inserted literally. - * *author*: Author for the LaTeX document. The same LaTeX markup caveat as + *startdocname* + String that specifies the relative path (without file suffix) from the + source directory to the document that is the master document of the LaTeX + file. All documents referenced by the *startdoc* document in TOC trees + will be included in the LaTeX file. (If you want to use the default master + document for your LaTeX build, provide your :confval:`master_doc` here.) + + *targetname* + File name of the LaTeX file in the output directory. + + *title* + LaTeX document title. Can be empty to use the title of the + *startdoc* document. This is inserted as LaTeX markup, so special + characters like a backslash or ampersand must be represented by the proper + LaTeX commands if they are to be inserted literally. + + * *author* + Author for the LaTeX document. The same LaTeX markup caveat as for *title* applies. Use ``\\and`` to separate multiple authors, as in: ``'John \\and Sarah'`` (backslashes must be Python-escaped to reach LaTeX). - * *documentclass*: Normally, one of ``'manual'`` or ``'howto'`` (provided + + *documentclass* + Normally, one of ``'manual'`` or ``'howto'`` (provided by Sphinx and based on ``'report'``, resp. ``'article'``; Japanese documents use ``'jsbook'``, resp. ``'jreport'``.) "howto" (non-Japanese) documents will not get appendices. Also they have a simpler title page. @@ -1786,7 +1796,8 @@ information. the "sphinx" package is always loaded in order to define Sphinx's custom LaTeX commands. - * *toctree_only*: Must be ``True`` or ``False``. If true, the *startdoc* + *toctree_only* + Must be ``True`` or ``False``. If true, the *startdoc* document itself is not included in the output, only the documents referenced by it via TOC trees. With this option, you can put extra stuff in the master document that shows up in the HTML, but not the LaTeX @@ -2227,9 +2238,11 @@ These options influence manual page output. section)``, where the items are: *startdocname* - Document name that is the "root" of the manual page. All documents - referenced by it in TOC trees will be included in the manual file too. - (If you want one master manual page, use your :confval:`master_doc` here.) + String that specifies the relative path (without file suffix) from the + source directory to the document that is the master of the manual page. + All documents referenced by the *startdoc* document in TOC trees will be + included in the manual file. (If you want to use the default master + document for your manual pages build, use your :confval:`master_doc` here.) *name* Name of the manual page. This should be a short string without spaces or @@ -2272,17 +2285,20 @@ These options influence Texinfo output. are: *startdocname* - Document name that is the "root" of the Texinfo file. All documents - referenced by it in TOC trees will be included in the Texinfo file too. - (If you want only one Texinfo file, use your :confval:`master_doc` here.) + String that specifies the relative path (without file suffix) from the + source directory to the document that is the master document of the Texinfo + file. All documents referenced by the *startdoc* document in TOC trees + will be included in the Texinfo file. (If you want to use the default + master document for your Texinfo build, provide your :confval:`master_doc` + here.) *targetname* File name (no extension) of the Texinfo file in the output directory. *title* - Texinfo document title. Can be empty to use the title of the *startdoc*. - Inserted as Texinfo markup, so special characters like ``@`` and ``{}`` - will need to be escaped to be inserted literally. + Texinfo document title. Can be empty to use the title of the *startdoc* + document. Inserted as Texinfo markup, so special characters like ``@`` and + ``{}`` will need to be escaped to be inserted literally. *author* Author for the Texinfo document. Inserted as Texinfo markup. Use ``@*`` From 6fe8835037fac473265b856822c82d1bc9de7c76 Mon Sep 17 00:00:00 2001 From: Honza Javorek Date: Tue, 3 Jul 2018 14:00:33 +0200 Subject: [PATCH 007/174] add default Accept header There are situations where requested server replies with a different content (in my particular case HTTP 404) when there is no accept header, possibly because it evaluates the content negotiation to an API request instead of a browser request. This change adds a default Accept header, which equals to what my Firefox sets out of the box to its requests. I stumbled upon this when checking a link to https://crates.io/crates/dredd-hooks. While curl -i https://crates.io/crates/dredd-hooks returns HTTP 404, following results in an expected HTTP 200 response with HTML body: curl -H 'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8' -i https://crates.io/crates/dredd-hooks --- sphinx/builders/linkcheck.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index 22e7f01ad..b43849022 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -120,12 +120,13 @@ class CheckExternalLinksBuilder(Builder): def check_thread(self): # type: () -> None - kwargs = {} + kwargs = { + 'allow_redirects': True, + 'headers': {'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'}, + } if self.app.config.linkcheck_timeout: kwargs['timeout'] = self.app.config.linkcheck_timeout - kwargs['allow_redirects'] = True - def check_uri(): # type: () -> Tuple[unicode, unicode, int] # split off anchor From 271e1d1340d669c890d6832f256304464702ff10 Mon Sep 17 00:00:00 2001 From: Honza Javorek Date: Tue, 3 Jul 2018 14:13:46 +0200 Subject: [PATCH 008/174] make linter happy --- sphinx/builders/linkcheck.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index b43849022..8079b680a 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -122,7 +122,10 @@ class CheckExternalLinksBuilder(Builder): # type: () -> None kwargs = { 'allow_redirects': True, - 'headers': {'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'}, + 'headers': { + 'Accept': ('text/html,application/xhtml+xml,' + 'application/xml;q=0.9,*/*;q=0.8') + }, } if self.app.config.linkcheck_timeout: kwargs['timeout'] = self.app.config.linkcheck_timeout From 9b2aac68ead15067205470ec28c94af909c080c0 Mon Sep 17 00:00:00 2001 From: jfbu Date: Sun, 15 Jul 2018 13:43:13 +0200 Subject: [PATCH 009/174] LaTeX: extend to all projects the #3742 fix for PDF builds at RTD Refs: https://github.com/rtfd/readthedocs.org/issues/2857 --- CHANGES | 5 +++++ doc/conf.py | 7 +------ doc/latex.rst | 20 ++++++++++++++++++-- doc/usage/configuration.rst | 17 ++++++++++------- sphinx/texinputs/sphinx.sty | 8 ++++++++ sphinx/writers/latex.py | 2 +- 6 files changed, 43 insertions(+), 16 deletions(-) diff --git a/CHANGES b/CHANGES index d7761f542..9f9a7b9ee 100644 --- a/CHANGES +++ b/CHANGES @@ -143,6 +143,11 @@ Features added for mathjax * #4362: latex: Don't overwrite .tex file if document not changed * #1431: latex: Add alphanumeric enumerated list support +* Extend to all projects not using the Sphinx LaTeX Makefile a workaround for + `issue rtfd/readthedocs.org#2857`__ about insufficient number of + ``pdflatex`` runs for index to show up in PDF bookmarks (refs: #3742) + + __ https://github.com/rtfd/readthedocs.org/issues/2857 Bugs fixed ---------- diff --git a/doc/conf.py b/doc/conf.py index 732c4d4a0..31cb8e478 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -64,12 +64,7 @@ latex_elements = { 'passoptionstopackages': '\\PassOptionsToPackage{svgnames}{xcolor}', 'preamble': '\\DeclareUnicodeCharacter{229E}{\\ensuremath{\\boxplus}}', 'fvset': '\\fvset{fontsize=auto}', - # fix missing index entry due to RTD doing only once pdflatex after makeindex - 'printindex': r''' -\IfFileExists{\jobname.ind} - {\footnotesize\raggedright\printindex} - {\begin{sphinxtheindex}\end{sphinxtheindex}} -''', + 'printindex': '\\footnotesize\\raggedright\\sphinxprintindex', } latex_show_urls = 'footnote' diff --git a/doc/latex.rst b/doc/latex.rst index cfd6f7d8b..ef0827957 100644 --- a/doc/latex.rst +++ b/doc/latex.rst @@ -55,7 +55,7 @@ example:: \setlength{\cftsecnumwidth}{1.25cm} ''', 'fncychap': r'\usepackage[Bjornstrup]{fncychap}', - 'printindex': r'\footnotesize\raggedright\printindex', + 'printindex': r'\footnotesize\raggedright\sphinxprintindex', } latex_show_urls = 'footnote' @@ -399,6 +399,21 @@ Macros :file:`sphinxmanual.cls` and :file:`sphinxhowto.cls`. - the citation reference is typeset via ``\sphinxcite`` which is a wrapper of standard ``\cite``. +- regarding the general index, the :confval:`latex_elements` dictionary has a + ``'printindex'`` key which defaults to ``'\\sphinxprintindex'``. It often + proves advantageous to use:: + + 'printindex': '\\footnotesize\\raggedright\\sphinxprintindex', + + especially if the index contains long entries. The LaTeX class for Japanese + ``'manual'``-type documents already does the font size and text + justification change, so the above is not needed then. + + .. tip:: + + Advanced LaTeX users can also, via :confval:`latex_additional_files`, use + a custom :file:`python.ist` style file for :program:`makeindex` to modify + the looks of the general index. Environments ~~~~~~~~~~~~ @@ -453,7 +468,8 @@ Environments - the bibliography uses ``sphinxthebibliography`` and the Python Module index as well as the general index both use ``sphinxtheindex``; these environments are wrappers of the ``thebibliography`` and respectively ``theindex`` - environments as provided by the document class (or packages). + environments, needed mainly to insert a corresponding entry in the PDF + bookmarks and table of contents. .. versionchanged:: 1.5 formerly, the original environments were modified by Sphinx. diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index a0fbe641a..01b67c498 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1727,8 +1727,8 @@ the `Dublin Core metadata `_. Options for LaTeX output ------------------------ -These options influence LaTeX output. Refer to :doc:`/latex` for more -information. +These options influence LaTeX output. For customization of LaTeX +macros and environments, see also :doc:`/latex`. .. confval:: latex_engine @@ -2108,11 +2108,14 @@ information. Remove unneeded ``{}`` after ``\\hrule``. ``'printindex'`` - "printindex" call, the last thing in the file, default - ``'\\printindex'``. Override if you want to generate the index - differently or append some content after the index. For example - ``'\\footnotesize\\raggedright\\printindex'`` is advisable when the - index is full of long entries. + "printindex" call, the last thing in the file. + + .. versionchanged:: 1.8 + Former default ``'\\printindex'`` now ``'\\sphinxprintindex'``. + This macro works around an issue__ with PDF builds at RTD doing too + few ``pdflatex`` runs. + + __ https://github.com/rtfd/readthedocs.org/issues/2857 ``'fvset'`` Customization of ``fancyvrb`` LaTeX package. Defaults to diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index 96be30338..bd8a26a30 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -459,6 +459,14 @@ } \fi +% provide \sphinxprintindex as variant of \printindex designed to workaround +% rtfd/readthedocs.org#2857 regarding "Index" entry in PDF bookmarks +\newcommand*{\sphinxprintindex}{% + \IfFileExists{\jobname.ind} + {\printindex} + {\begin{sphinxtheindex}\end{sphinxtheindex}}% +}% + % make commands known to non-Sphinx document classes \providecommand*{\sphinxtableofcontents}{\tableofcontents} \ltx@ifundefined{sphinxthebibliography} diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 55d37da79..9c184dc5f 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -124,7 +124,7 @@ DEFAULT_SETTINGS = { 'maketitle': '\\maketitle', 'tableofcontents': '\\sphinxtableofcontents', 'atendofbody': '', - 'printindex': '\\printindex', + 'printindex': '\\sphinxprintindex', 'transition': '\n\n\\bigskip\\hrule\\bigskip\n\n', 'figure_align': 'htbp', 'tocdepth': '', From 99e696415290900cc174defd8fa74ec8645dd0aa Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 21 Jun 2018 23:56:29 +0900 Subject: [PATCH 010/174] Handle errors on scanning documents (refs: #5114) --- CHANGES | 1 + sphinx/environment/__init__.py | 65 ++++++++++++++++++---------------- sphinx/errors.py | 5 +++ 3 files changed, 40 insertions(+), 31 deletions(-) diff --git a/CHANGES b/CHANGES index ca7bef359..c2a7b1c53 100644 --- a/CHANGES +++ b/CHANGES @@ -152,6 +152,7 @@ Bugs fixed * #4945: i18n: fix lang_COUNTRY not fallback correctly for IndexBuilder. Thanks to Shengjing Zhu. * #4983: productionlist directive generates invalid IDs for the tokens +* #5114: sphinx-build: Handle errors on scanning documents Testing -------- diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index e9f3338aa..fcc99b7cd 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -25,7 +25,7 @@ from sphinx import addnodes from sphinx.deprecation import RemovedInSphinx20Warning, RemovedInSphinx30Warning from sphinx.environment.adapters.indexentries import IndexEntries from sphinx.environment.adapters.toctree import TocTree -from sphinx.errors import SphinxError, BuildEnvironmentError, ExtensionError +from sphinx.errors import SphinxError, BuildEnvironmentError, DocumentError, ExtensionError from sphinx.locale import __ from sphinx.transforms import SphinxTransformer from sphinx.util import get_matching_docs, FilenameUniqDict @@ -416,37 +416,40 @@ class BuildEnvironment(object): """Find all source files in the source dir and put them in self.found_docs. """ - matchers = compile_matchers( - config.exclude_patterns[:] + - config.templates_path + - builder.get_asset_paths() + - ['**/_sources', '.#*', '**/.#*', '*.lproj/**'] - ) - self.found_docs = set() - for docname in get_matching_docs(self.srcdir, config.source_suffix, # type: ignore - exclude_matchers=matchers): - if os.access(self.doc2path(docname), os.R_OK): - self.found_docs.add(docname) - else: - logger.warning(__("document not readable. Ignored."), location=docname) + try: + matchers = compile_matchers( + config.exclude_patterns[:] + + config.templates_path + + builder.get_asset_paths() + + ['**/_sources', '.#*', '**/.#*', '*.lproj/**'] + ) + self.found_docs = set() + for docname in get_matching_docs(self.srcdir, config.source_suffix, # type: ignore + exclude_matchers=matchers): + if os.access(self.doc2path(docname), os.R_OK): + self.found_docs.add(docname) + else: + logger.warning(__("document not readable. Ignored."), location=docname) - # Current implementation is applying translated messages in the reading - # phase.Therefore, in order to apply the updated message catalog, it is - # necessary to re-process from the reading phase. Here, if dependency - # is set for the doc source and the mo file, it is processed again from - # the reading phase when mo is updated. In the future, we would like to - # move i18n process into the writing phase, and remove these lines. - if builder.use_message_catalog: - # add catalog mo file dependency - for docname in self.found_docs: - catalog_files = find_catalog_files( - docname, - self.srcdir, - self.config.locale_dirs, - self.config.language, - self.config.gettext_compact) - for filename in catalog_files: - self.dependencies[docname].add(filename) + # Current implementation is applying translated messages in the reading + # phase.Therefore, in order to apply the updated message catalog, it is + # necessary to re-process from the reading phase. Here, if dependency + # is set for the doc source and the mo file, it is processed again from + # the reading phase when mo is updated. In the future, we would like to + # move i18n process into the writing phase, and remove these lines. + if builder.use_message_catalog: + # add catalog mo file dependency + for docname in self.found_docs: + catalog_files = find_catalog_files( + docname, + self.srcdir, + self.config.locale_dirs, + self.config.language, + self.config.gettext_compact) + for filename in catalog_files: + self.dependencies[docname].add(filename) + except EnvironmentError as exc: + raise DocumentError(__('Failed to scan documents in %s: %r') % (self.srcdir, exc)) def get_outdated_files(self, config_changed): # type: (bool) -> Tuple[Set[unicode], Set[unicode], Set[unicode]] diff --git a/sphinx/errors.py b/sphinx/errors.py index 83c1bd9da..e97447e86 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -82,6 +82,11 @@ class ConfigError(SphinxError): category = 'Configuration error' +class DocumentError(SphinxError): + """Document error.""" + category = 'Document error' + + class ThemeError(SphinxError): """Theme error.""" category = 'Theme error' From 82f9c69b3c865c5b437e623f3bafb5bd6fc3ef45 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 16 Jul 2018 15:27:59 +0900 Subject: [PATCH 011/174] Fix #5163: html: hlist items are now aligned to top --- CHANGES | 1 + sphinx/themes/basic/static/basic.css_t | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/CHANGES b/CHANGES index ca7bef359..dafd09eb6 100644 --- a/CHANGES +++ b/CHANGES @@ -39,6 +39,7 @@ Incompatible changes Please use ``app.add_js_file()`` instead. * #5072: Save environment object also with only new documents * #5035: qthelp builder allows dashes in :confval:`qthelp_namespace` +* #5163: html: hlist items are now aligned to top Deprecated ---------- diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index d25c5af9d..cab3a342b 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -427,6 +427,13 @@ table.field-list td, table.field-list th { hyphens: manual; } +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist td { + vertical-align: top; +} + + /* -- other body styles ----------------------------------------------------- */ ol.arabic { From 02bccb67e17ab241d858b2c8f952acb8c8c73514 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 15 Jul 2018 22:23:26 +0900 Subject: [PATCH 012/174] Fix #5164: incremental build has broken with external source_parser --- sphinx/registry.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/sphinx/registry.py b/sphinx/registry.py index f95a8fe7d..2c73dbbd3 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -39,6 +39,7 @@ if False: from docutils.transforms import Transform # NOQA from sphinx.application import Sphinx # NOQA from sphinx.builders import Builder # NOQA + from sphinx.config import Config # NOQA from sphinx.domains import Domain, Index # NOQA from sphinx.environment import BuildEnvironment # NOQA from sphinx.ext.autodoc import Documenter # NOQA @@ -270,7 +271,7 @@ class SphinxComponentRegistry(object): # type: (unicode, unicode, bool) -> None logger.debug('[app] adding source_suffix: %r, %r', suffix, filetype) if suffix in self.source_suffix and not override: - raise ExtensionError(__('source_parser for %r is already registered') % suffix) + raise ExtensionError(__('source_suffix %r is already registered') % suffix) else: self.source_suffix[suffix] = filetype @@ -290,7 +291,7 @@ class SphinxComponentRegistry(object): parser = args[1] if suffix: - self.add_source_suffix(suffix, suffix) + self.add_source_suffix(suffix, suffix, override=True) if len(parser.supported) == 0: warnings.warn('Old source_parser has been detected. Please fill Parser.supported ' @@ -493,8 +494,8 @@ class SphinxComponentRegistry(object): return envversion -def merge_source_suffix(app): - # type: (Sphinx) -> None +def merge_source_suffix(app, config): + # type: (Sphinx, Config) -> None """Merge source_suffix which specified by user and added by extensions.""" for suffix, filetype in iteritems(app.registry.source_suffix): if suffix not in app.config.source_suffix: @@ -510,7 +511,7 @@ def merge_source_suffix(app): def setup(app): # type: (Sphinx) -> Dict[unicode, Any] - app.connect('builder-inited', merge_source_suffix) + app.connect('config-inited', merge_source_suffix) return { 'version': 'builtin', From c126067f4ea1c70d37f4e04979c4afa9f508058b Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Mon, 16 Jul 2018 23:17:44 +0200 Subject: [PATCH 013/174] #4886 add tests to better cover the current link check ignore configuration behavior --- tests/roots/test-linkcheck/links.txt | 2 ++ tests/test_build_linkcheck.py | 13 ++++++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/tests/roots/test-linkcheck/links.txt b/tests/roots/test-linkcheck/links.txt index 36376bef4..d5057e08e 100644 --- a/tests/roots/test-linkcheck/links.txt +++ b/tests/roots/test-linkcheck/links.txt @@ -9,3 +9,5 @@ Some additional anchors to exercise ignore code * `Example Bar invalid `_ * `Example Bar invalid `_ tests that default ignore anchor of #! does not need to be prefixed with / * `Example Bar invalid `_ +* `Example anchor invalid `_ +* `Complete nonsense `_ diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index 839a15628..560eb2499 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -21,14 +21,21 @@ def test_defaults(app, status, warning): content = (app.outdir / 'output.txt').text() print(content) - # looking for #top should fail + # looking for '#top' and 'does-not-exist' not found should fail assert "Anchor 'top' not found" in content - assert len(content.splitlines()) == 1 + assert "Anchor 'does-not-exist' not found" in content + # looking for non-existent URL should fail + assert " Max retries exceeded with url: /doesnotexist" in content + assert len(content.splitlines()) == 3 @pytest.mark.sphinx( 'linkcheck', testroot='linkcheck', freshenv=True, - confoverrides={'linkcheck_anchors_ignore': ["^!", "^top$"]}) + confoverrides={'linkcheck_anchors_ignore': ["^!", "^top$"], + 'linkcheck_ignore': [ + 'https://localhost:7777/doesnotexist', + 'http://www.sphinx-doc.org/en/1.7/intro.html#*'] + }) def test_anchors_ignored(app, status, warning): app.builder.build_all() From 537a69e5180f3380490592204022ff30f4a7556e Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Mon, 16 Jul 2018 23:22:26 +0200 Subject: [PATCH 014/174] #4886 adjust documentation to match actual link check behavior --- doc/usage/configuration.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 8db606515..288290a27 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2485,12 +2485,20 @@ Options for the linkcheck builder .. confval:: linkcheck_anchors_ignore - A list of regular expressions that match URIs that should skip checking - the validity of anchors in links. This allows skipping entire sites, where - anchors are used to control dynamic pages, or just specific anchors within - a page, where JavaScript is used to add anchors dynamically, or use the - fragment as part of to trigger an internal REST request. Default is - ``["/#!"]``. + A list of regular expressions that match anchors Sphinx should skip when + checking the validity of anchors in links. This allows skipping anchors that + a website's JavaScript adds to control dynamic pages or when triggering an + internal REST request. Default is ``["^!"]``. + + .. note:: + + If you want to ignore anchors of a specific page or of pages that match a + specific pattern, use :confval:`linkcheck_ignore` instead, for example as + follows:: + + linkcheck_ignore = [ + 'http://www.sphinx-doc.org/en/1.7/intro.html#*' + ] .. versionadded:: 1.5 From e1772bafda88cac5e37142f67ef5cd4c8cc3c504 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 17 Jul 2018 10:00:05 +0200 Subject: [PATCH 015/174] DOC: Fix typo: add_source_parsers() -> add_source_parser() --- doc/extdev/parserapi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/extdev/parserapi.rst b/doc/extdev/parserapi.rst index 11a690387..0beb51711 100644 --- a/doc/extdev/parserapi.rst +++ b/doc/extdev/parserapi.rst @@ -12,7 +12,7 @@ __ http://docutils.sourceforge.net/docs/dev/hacking.html#parsing-the-document In Sphinx, the parser modules works as same as docutils. The parsers are registered to Sphinx by extensions using Application APIs; -:meth:`.Sphinx.add_source_suffix()` and :meth:`.Sphinx.add_source_parsers()`. +:meth:`.Sphinx.add_source_suffix()` and :meth:`.Sphinx.add_source_parser()`. The *source suffix* is a mapping from file suffix to file type. For example, ``.rst`` file is mapped to ``'restructuredtext'`` type. Sphinx uses the From fd3e7a56c3e48a0ef28f37cb234783e32df280c8 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 17 Jul 2018 11:19:31 +0200 Subject: [PATCH 016/174] LaTeX: Fix #5134 Lisp syntax for some xindy merge-rule patterns --- sphinx/texinputs/sphinx.xdy | 47 +++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/sphinx/texinputs/sphinx.xdy b/sphinx/texinputs/sphinx.xdy index f0c8b8a65..5f1fa3aaf 100644 --- a/sphinx/texinputs/sphinx.xdy +++ b/sphinx/texinputs/sphinx.xdy @@ -91,26 +91,33 @@ ;; from non-ascii letters which end up (with pdflatex) as \IeC macros in .idx ;; file, with a blank. -(merge-rule "\\sphinxleftcurlybrace\{\}" "{") -(merge-rule "\\sphinxrightcurlybrace\{\}" "}") -(merge-rule "\\_" "_") -(merge-rule "\{\[\}" "[") -(merge-rule "\{\]\}" "]") -(merge-rule "\{\}`" "`") -(merge-rule "\\textbackslash\{\}" "\\") -(merge-rule "\\textasciitilde\{\}" "~~") -(merge-rule "\\textless\{\}" "<") -(merge-rule "\\textgreater\{\}" ">") -(merge-rule "\\textasciicircum\{\}" "^") -(merge-rule "\\P\{\}" "¶") -(merge-rule "\\S\{\}" "§") -(merge-rule "\\texteuro\{\}" "€") -(merge-rule "\\\(\\infty\\\)" "∞") -(merge-rule "\\\(\\pm\\\)" "±") -(merge-rule "\\\(\\rightarrow\\\)" "→") -(merge-rule "\\\(\\checkmark\\\)" "✓") -(merge-rule "\\textendash\{\}" "–") -(merge-rule "\\textbar\{\}" "|") +;; Details of the syntax are explained at +;; http://xindy.sourceforge.net/doc/manual-3.html +;; In absence of :string, "xindy uses an auto-detection mechanism to decide, +;; if the pattern is a regular expression or not". But it is not obvious to +;; guess, for example "\\_" is not detected as RE but "\\P\{\}" is, so for +;; being sure we apply the :string switch everywhere and do not use \\ etc... + +(merge-rule "\sphinxleftcurlybrace{}" "{" :string) +(merge-rule "\sphinxrightcurlybrace{}" "}" :string) +(merge-rule "\_" "_" :string) +(merge-rule "{[}" "[" :string) +(merge-rule "{]}" "]" :string) +(merge-rule "{}`" "`" :string) +(merge-rule "\textbackslash{}" "\" :string) ; " for Emacs syntax highlighting +(merge-rule "\textasciitilde{}" "~~" :string); the ~~ escape is needed here +(merge-rule "\textless{}" "<" :string) +(merge-rule "\textgreater{}" ">" :string) +(merge-rule "\textasciicircum{}" "^" :string) +(merge-rule "\P{}" "¶" :string) +(merge-rule "\S{}" "§" :string) +(merge-rule "\texteuro{}" "€" :string) +(merge-rule "\(\infty\)" "∞" :string) +(merge-rule "\(\pm\)" "±" :string) +(merge-rule "\(\rightarrow\)" "→" :string) +(merge-rule "\(\checkmark\)" "✓" :string) +(merge-rule "\textendash{}" "–" :string) +(merge-rule "\textbar{}" "|" :string) ;; This xindy module provides some basic support for "see" (require "makeindex.xdy") From e584b8e1db531be350c2f6fcf64a416803206738 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 17 Jul 2018 15:45:30 +0200 Subject: [PATCH 017/174] Update LaTeX docs --- doc/latex.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/latex.rst b/doc/latex.rst index ef0827957..6118fdee6 100644 --- a/doc/latex.rst +++ b/doc/latex.rst @@ -412,8 +412,10 @@ Macros .. tip:: Advanced LaTeX users can also, via :confval:`latex_additional_files`, use - a custom :file:`python.ist` style file for :program:`makeindex` to modify - the looks of the general index. + a custom :program:`makeindex` style file :file:`python.ist`, or a custom + :program:`xindy` style file :file:`sphinx.xdy` (see + :confval:`latex_use_xindy`) in order to modify how the general index is + typeset. Environments ~~~~~~~~~~~~ From f605012617d4e1005cab02393fb0cf4ea9cd435f Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Tue, 17 Jul 2018 20:40:49 +0200 Subject: [PATCH 018/174] #4886 remove obsolete `*` --- doc/usage/configuration.rst | 2 +- tests/test_build_linkcheck.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 288290a27..288b95ae4 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2497,7 +2497,7 @@ Options for the linkcheck builder follows:: linkcheck_ignore = [ - 'http://www.sphinx-doc.org/en/1.7/intro.html#*' + 'http://www.sphinx-doc.org/en/1.7/intro.html#' ] .. versionadded:: 1.5 diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py index 560eb2499..1716a0c42 100644 --- a/tests/test_build_linkcheck.py +++ b/tests/test_build_linkcheck.py @@ -34,7 +34,7 @@ def test_defaults(app, status, warning): confoverrides={'linkcheck_anchors_ignore': ["^!", "^top$"], 'linkcheck_ignore': [ 'https://localhost:7777/doesnotexist', - 'http://www.sphinx-doc.org/en/1.7/intro.html#*'] + 'http://www.sphinx-doc.org/en/1.7/intro.html#'] }) def test_anchors_ignored(app, status, warning): app.builder.build_all() From c2a396c776bf4dbc6c92e47808ab553ad262ec48 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 17 Jul 2018 23:54:53 +0200 Subject: [PATCH 019/174] LaTeX: for Cyrillic and with xindy, get Latin letter groups too Refs: #5134 --- sphinx/texinputs/Makefile_t | 3 ++ sphinx/texinputs/sphinx-basiclatin.xdy | 42 ++++++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 sphinx/texinputs/sphinx-basiclatin.xdy diff --git a/sphinx/texinputs/Makefile_t b/sphinx/texinputs/Makefile_t index 1ce4b1324..97054def0 100644 --- a/sphinx/texinputs/Makefile_t +++ b/sphinx/texinputs/Makefile_t @@ -27,6 +27,9 @@ export XINDYOPTS = {{ xindy_lang_option }} -M sphinx.xdy {% if latex_engine == 'pdflatex' and xindy_cyrillic -%} XINDYOPTS += -M cyrLICRutf8.xdy {% endif -%} +{% if xindy_cyrillic -%} +XINDYOPTS += -M sphinx-basiclatin.xdy +{% endif -%} {% if latex_engine == 'xelatex' or latex_engine == 'lualatex' -%} XINDYOPTS += -I xelatex {% endif -%} diff --git a/sphinx/texinputs/sphinx-basiclatin.xdy b/sphinx/texinputs/sphinx-basiclatin.xdy new file mode 100644 index 000000000..f611ac5ca --- /dev/null +++ b/sphinx/texinputs/sphinx-basiclatin.xdy @@ -0,0 +1,42 @@ +;; xindy style file to provide indexing of (ascii) Latin names +;; in an otherwise non-Latin (i.e. Cyrillic) context. +;; TODO: should we support also iso-latin-1 ? +;; Contributed by the Sphinx team, July 2018. + +(define-letter-groups + ("A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" + "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z")) + +(define-rule-set "latin-toupper" + + :rules (("a" "A" :string :again) + ("b" "B" :string :again) + ("c" "C" :string :again) + ("d" "D" :string :again) + ("e" "E" :string :again) + ("f" "F" :string :again) + ("g" "G" :string :again) + ("h" "H" :string :again) + ("i" "I" :string :again) + ("j" "J" :string :again) + ("k" "K" :string :again) + ("l" "L" :string :again) + ("m" "M" :string :again) + ("n" "N" :string :again) + ("o" "O" :string :again) + ("p" "P" :string :again) + ("q" "Q" :string :again) + ("r" "R" :string :again) + ("s" "S" :string :again) + ("t" "T" :string :again) + ("u" "U" :string :again) + ("v" "V" :string :again) + ("w" "W" :string :again) + ("x" "X" :string :again) + ("y" "Y" :string :again) + ("z" "Z" :string :again) + )) + +(use-rule-set + :run 0 + :rule-set ("latin-toupper")) From c62aefd71f24dbf6b40f4f1624523b9b2eae4bf4 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 19 Jul 2018 01:18:39 +0900 Subject: [PATCH 020/174] Fix mypy violation --- sphinx/setup_command.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index c3957fefc..ca3256c19 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -28,7 +28,7 @@ from sphinx.util.osutil import abspath if False: # For type annotation - from typing import Any, List, Tuple # NOQA + from typing import Any, Dict, List, Tuple # NOQA class BuildDoc(Command): @@ -165,7 +165,7 @@ class BuildDoc(Command): status_stream = StringIO() else: status_stream = sys.stdout # type: ignore - confoverrides = {} + confoverrides = {} # type: Dict[unicode, Any] if self.project: confoverrides['project'] = self.project if self.version: From f72a53f5bd46bfb100e56a1a07fa177f459c2fd3 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 19 Jul 2018 01:22:20 +0900 Subject: [PATCH 021/174] Update docs for #5122 (nitpicky option) --- CHANGES | 1 + doc/setuptools.rst | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/CHANGES b/CHANGES index bad46f5f8..e57a0dad6 100644 --- a/CHANGES +++ b/CHANGES @@ -161,6 +161,7 @@ Features added * Add :confval:`latex_use_xindy` for UTF-8 savvy indexing, defaults to ``True`` if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter +* #5122: setuptools: support nitpicky option Bugs fixed ---------- diff --git a/doc/setuptools.rst b/doc/setuptools.rst index 10f732559..10cc6a77d 100644 --- a/doc/setuptools.rst +++ b/doc/setuptools.rst @@ -181,6 +181,14 @@ Options for setuptools integration .. versionadded:: 1.3 +.. confval:: nitpicky + + Run in nit-picky mode. Currently, this generates warnings for all missing + references. See the config value :confval:`nitpick_ignore` for a way to + exclude some references as "known missing". + + .. versionadded:: 1.8 + .. confval:: pdb A boolean to configure ``pdb`` on exception. Default is false. From 8066d36e3cba5eabc09ed95dc2f9055d4badc2ca Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Wed, 18 Jul 2018 19:40:22 +0200 Subject: [PATCH 022/174] #4886 clarify example/note --- doc/usage/configuration.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 288b95ae4..22d0966b4 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2493,8 +2493,9 @@ Options for the linkcheck builder .. note:: If you want to ignore anchors of a specific page or of pages that match a - specific pattern, use :confval:`linkcheck_ignore` instead, for example as - follows:: + specific pattern (but still check occurrences of the same page(s) that + don't have anchors), use :confval:`linkcheck_ignore` instead, for example + as follows:: linkcheck_ignore = [ 'http://www.sphinx-doc.org/en/1.7/intro.html#' From f272d6876cb499ac25f779e606593e3459e565b7 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 20 Jul 2018 01:28:38 +0900 Subject: [PATCH 023/174] Remove unused code Now sphinx depends on pygments-2.0 or higher. So this code is not passed. --- sphinx/highlighting.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 7d5956570..dd248107c 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -161,8 +161,6 @@ class PygmentsBridge(object): if self.dest == 'html': return hlsource else: - if not isinstance(hlsource, text_type): # Py2 / Pygments < 1.6 - hlsource = hlsource.decode() return hlsource.translate(tex_hl_escape_map_new) def get_stylesheet(self): From 395d60d49e982a5113afb0ab0118ae1250d9c23a Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Thu, 19 Jul 2018 21:10:16 +0200 Subject: [PATCH 024/174] #4255 improve conciseness --- doc/usage/configuration.rst | 65 +++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 35 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 98cc4ab8d..b4d4a4f84 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1766,9 +1766,8 @@ information. documentclass, toctree_only)``, where the items are: *startdocname* - String that specifies the relative path (without file suffix) from the - source directory to the document that is the master document of the LaTeX - file. All documents referenced by the *startdoc* document in TOC trees + String that specifies the :term:`document name` of the LaTeX file's master + document. All documents referenced by the *startdoc* document in TOC trees will be included in the LaTeX file. (If you want to use the default master document for your LaTeX build, provide your :confval:`master_doc` here.) @@ -1776,32 +1775,29 @@ information. File name of the LaTeX file in the output directory. *title* - LaTeX document title. Can be empty to use the title of the - *startdoc* document. This is inserted as LaTeX markup, so special - characters like a backslash or ampersand must be represented by the proper - LaTeX commands if they are to be inserted literally. + LaTeX document title. Can be empty to use the title of the *startdoc* + document. This is inserted as LaTeX markup, so special characters like a + backslash or ampersand must be represented by the proper LaTeX commands if + they are to be inserted literally. - * *author* - Author for the LaTeX document. The same LaTeX markup caveat as - for *title* applies. Use ``\\and`` to separate multiple authors, as in: - ``'John \\and Sarah'`` (backslashes must be Python-escaped to reach - LaTeX). + *author* + Author for the LaTeX document. The same LaTeX markup caveat as for *title* + applies. Use ``\\and`` to separate multiple authors, as in: + ``'John \\and Sarah'`` (backslashes must be Python-escaped to reach LaTeX). *documentclass* - Normally, one of ``'manual'`` or ``'howto'`` (provided - by Sphinx and based on ``'report'``, resp. ``'article'``; Japanese - documents use ``'jsbook'``, resp. ``'jreport'``.) "howto" (non-Japanese) - documents will not get appendices. Also they have a simpler title page. - Other document classes can be given. Independently of the document class, - the "sphinx" package is always loaded in order to define Sphinx's custom - LaTeX commands. + Normally, one of ``'manual'`` or ``'howto'`` (provided by Sphinx and based + on ``'report'``, resp. ``'article'``; Japanese documents use ``'jsbook'``, + resp. ``'jreport'``.) "howto" (non-Japanese) documents will not get + appendices. Also they have a simpler title page. Other document classes + can be given. Independently of the document class, the "sphinx" package is + always loaded in order to define Sphinx's custom LaTeX commands. *toctree_only* - Must be ``True`` or ``False``. If true, the *startdoc* - document itself is not included in the output, only the documents - referenced by it via TOC trees. With this option, you can put extra stuff - in the master document that shows up in the HTML, but not the LaTeX - output. + Must be ``True`` or ``False``. If true, the *startdoc* document itself is + not included in the output, only the documents referenced by it via TOC + trees. With this option, you can put extra stuff in the master document + that shows up in the HTML, but not the LaTeX output. .. versionadded:: 1.2 In the past including your own document class required you to prepend the @@ -2238,11 +2234,11 @@ These options influence manual page output. section)``, where the items are: *startdocname* - String that specifies the relative path (without file suffix) from the - source directory to the document that is the master of the manual page. - All documents referenced by the *startdoc* document in TOC trees will be - included in the manual file. (If you want to use the default master - document for your manual pages build, use your :confval:`master_doc` here.) + String that specifies the :term:`document name` of the manual page's master + document. All documents referenced by the *startdoc* document in TOC trees + will be included in the manual file. (If you want to use the default + master document for your manual pages build, use your :confval:`master_doc` + here.) *name* Name of the manual page. This should be a short string without spaces or @@ -2285,12 +2281,11 @@ These options influence Texinfo output. are: *startdocname* - String that specifies the relative path (without file suffix) from the - source directory to the document that is the master document of the Texinfo - file. All documents referenced by the *startdoc* document in TOC trees - will be included in the Texinfo file. (If you want to use the default - master document for your Texinfo build, provide your :confval:`master_doc` - here.) + String that specifies the :term:`document name` of the the Texinfo file's + master document. All documents referenced by the *startdoc* document in + TOC trees will be included in the Texinfo file. (If you want to use the + default master document for your Texinfo build, provide your + :confval:`master_doc` here.) *targetname* File name (no extension) of the Texinfo file in the output directory. From 0c277f3ff007a464d7769c9561c449428d38dabc Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 20 Jul 2018 01:37:31 +0900 Subject: [PATCH 025/174] ``sphinx.highlighting.PygmentsBridge.unhighlight()`` is deprecated --- CHANGES | 1 + doc/extdev/index.rst | 5 +++++ sphinx/highlighting.py | 5 +++++ 3 files changed, 11 insertions(+) diff --git a/CHANGES b/CHANGES index e57a0dad6..e1aa4e5f8 100644 --- a/CHANGES +++ b/CHANGES @@ -102,6 +102,7 @@ Deprecated * ``sphinx.ext.mathbase.eqref`` node is deprecated * ``sphinx.ext.mathbase.is_in_section_title()`` is deprecated * ``sphinx.ext.mathbase.MathDomain`` is deprecated +* ``sphinx.highlighting.PygmentsBridge.unhighlight()`` is deprecated For more details, see `deprecation APIs list `_ diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 7aa6a7948..98824f7ed 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -131,6 +131,11 @@ The following is a list of deprecated interface. - 4.0 - :meth:`~sphinx.application.Sphinx.add_js_file()` + * - ``sphinx.highlighting.PygmentsBridge.unhighlight()`` + - 1.8 + - 3.0 + - N/A + * - ``sphinx.ext.mathbase.MathDomain`` - 1.8 - 3.0 diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index dd248107c..f31ff88cc 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -9,6 +9,8 @@ :license: BSD, see LICENSE for details. """ +import warnings + from pygments import highlight from pygments.filters import ErrorToken from pygments.formatters import HtmlFormatter, LatexFormatter @@ -20,6 +22,7 @@ from pygments.styles import get_style_by_name from pygments.util import ClassNotFound from six import text_type +from sphinx.deprecation import RemovedInSphinx30Warning from sphinx.ext import doctest from sphinx.locale import __ from sphinx.pygments_styles import SphinxStyle, NoneStyle @@ -93,6 +96,8 @@ class PygmentsBridge(object): def unhighlighted(self, source): # type: (unicode) -> unicode + warnings.warn('PygmentsBridge.unhighlighted() is now deprecated.', + RemovedInSphinx30Warning) if self.dest == 'html': return '
' + htmlescape(source) + '
\n' else: From 2bafb531795258223ed3d81a005b19338f8b1a5e Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 20 Jul 2018 18:44:01 +0900 Subject: [PATCH 026/174] Add testcase for trim_doctest_flags --- tests/roots/test-trim_doctest_flags/conf.py | 9 ++++++ tests/roots/test-trim_doctest_flags/index.rst | 23 +++++++++++++ tests/test_config_trim_doctest_flags.py | 32 +++++++++++++++++++ tests/test_highlighting.py | 10 ------ 4 files changed, 64 insertions(+), 10 deletions(-) create mode 100644 tests/roots/test-trim_doctest_flags/conf.py create mode 100644 tests/roots/test-trim_doctest_flags/index.rst create mode 100644 tests/test_config_trim_doctest_flags.py diff --git a/tests/roots/test-trim_doctest_flags/conf.py b/tests/roots/test-trim_doctest_flags/conf.py new file mode 100644 index 000000000..693c7c371 --- /dev/null +++ b/tests/roots/test-trim_doctest_flags/conf.py @@ -0,0 +1,9 @@ +# -*- coding: utf-8 -*- + +master_doc = 'index' + +extensions = ['sphinx.ext.doctest'] + +latex_documents = [ + (master_doc, 'test.tex', 'The basic Sphinx documentation for testing', 'Sphinx', 'report') +] diff --git a/tests/roots/test-trim_doctest_flags/index.rst b/tests/roots/test-trim_doctest_flags/index.rst new file mode 100644 index 000000000..1934d617b --- /dev/null +++ b/tests/roots/test-trim_doctest_flags/index.rst @@ -0,0 +1,23 @@ +test-trim_doctest_flags +======================= + +.. code-block:: pycon + + >>> datetime.date.now() # doctest: +FOO + datetime.date(2008, 1, 1) + +.. code-block:: none + + >>> datetime.date.now() # doctest: +BAR + datetime.date(2008, 1, 1) + +.. code-block:: guess + + # vim: set filetype=pycon + >>> datetime.date.now() # doctest: +BAZ + datetime.date(2008, 1, 1) + +.. testcode:: + + >>> datetime.date.now() # doctest: +QUX + datetime.date(2008, 1, 1) diff --git a/tests/test_config_trim_doctest_flags.py b/tests/test_config_trim_doctest_flags.py new file mode 100644 index 000000000..3be1b27a2 --- /dev/null +++ b/tests/test_config_trim_doctest_flags.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8 -*- +""" + test_config_trim_doctest_flags + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + +import pytest + + +@pytest.mark.sphinx('html', testroot='trim_doctest_flags') +def test_trim_doctest_flags_html(app, status, warning): + app.build() + + result = (app.outdir / 'index.html').text(encoding='utf8') + assert 'FOO' not in result + assert 'BAR' in result + assert 'BAZ' not in result + assert 'QUX' not in result + + +@pytest.mark.sphinx('latex', testroot='trim_doctest_flags') +def test_trim_doctest_flags_latex(app, status, warning): + app.build() + + result = (app.outdir / 'test.tex').text(encoding='utf8') + assert 'FOO' not in result + assert 'BAR' in result + assert 'BAZ' not in result + assert 'QUX' not in result diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index 6b11926c9..29a4c043a 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -76,16 +76,6 @@ def test_set_formatter(): PygmentsBridge.html_formatter = HtmlFormatter -def test_trim_doctest_flags(): - PygmentsBridge.html_formatter = MyFormatter - try: - bridge = PygmentsBridge('html', trim_doctest_flags=True) - ret = bridge.highlight_block('>>> 1+2 # doctest: SKIP\n3\n', 'pycon') - assert ret == '>>> 1+2 \n3\n' - finally: - PygmentsBridge.html_formatter = HtmlFormatter - - @mock.patch('sphinx.highlighting.logger') def test_default_highlight(logger): bridge = PygmentsBridge('html') From 4f296c5e6789292bbacd0558c2d671fa5025d580 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 21 Jul 2018 00:13:31 +0900 Subject: [PATCH 027/174] Refactor: Run highlightlang on resolving phase --- CHANGES | 10 ++ doc/extdev/index.rst | 45 +++++++++ sphinx/application.py | 1 + sphinx/transforms/post_transforms/code.py | 106 ++++++++++++++++++++++ sphinx/writers/html.py | 62 ++++++++----- sphinx/writers/html5.py | 62 ++++++++----- sphinx/writers/latex.py | 42 +++------ sphinx/writers/manpage.py | 8 -- sphinx/writers/texinfo.py | 8 -- sphinx/writers/text.py | 4 - 10 files changed, 253 insertions(+), 95 deletions(-) create mode 100644 sphinx/transforms/post_transforms/code.py diff --git a/CHANGES b/CHANGES index e1aa4e5f8..e5d143104 100644 --- a/CHANGES +++ b/CHANGES @@ -49,6 +49,7 @@ Incompatible changes upgrading Sphinx, please clean latex build repertory of existing project before new build. * #5163: html: hlist items are now aligned to top +* ``highlightlang`` directive is processed on resolving phase Deprecated ---------- @@ -96,7 +97,16 @@ Deprecated * ``sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.bibitems`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.hlsettingstack`` is deprecated * ``sphinx.writers.latex.ExtBabel.get_shorthandoff()`` is deprecated +* ``sphinx.writers.html.HTMLTranslator.highlightlang`` is deprecated +* ``sphinx.writers.html.HTMLTranslator.highlightlang_base`` is deprecated +* ``sphinx.writers.html.HTMLTranslator.highlightlangopts`` is deprecated +* ``sphinx.writers.html.HTMLTranslator.highlightlinenothreshold`` is deprecated +* ``sphinx.writers.html5.HTMLTranslator.highlightlang`` is deprecated +* ``sphinx.writers.html5.HTMLTranslator.highlightlang_base`` is deprecated +* ``sphinx.writers.html5.HTMLTranslator.highlightlangopts`` is deprecated +* ``sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold`` is deprecated * ``sphinx.ext.mathbase.math`` node is deprecated * ``sphinx.ext.mathbase.displaymath`` node is deprecated * ``sphinx.ext.mathbase.eqref`` node is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 98824f7ed..fe0d1b97e 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -221,11 +221,56 @@ The following is a list of deprecated interface. - 3.0 - N/A + * - ``sphinx.writers.latex.LaTeXTranslator.hlsettingstack`` + - 1.8 + - 3.0 + - N/A + * - ``sphinx.writers.latex.ExtBabel.get_shorthandoff()`` - 1.8 - 3.0 - N/A + * - ``sphinx.writers.html.HTMLTranslator.highlightlang()`` + - 1.8 + - 3.0 + - N/A + + * - ``sphinx.writers.html.HTMLTranslator.highlightlang_base()`` + - 1.8 + - 3.0 + - N/A + + * - ``sphinx.writers.html.HTMLTranslator.highlightlangopts()`` + - 1.8 + - 3.0 + - N/A + + * - ``sphinx.writers.html.HTMLTranslator.highlightlinenothreshold()`` + - 1.8 + - 3.0 + - N/A + + * - ``sphinx.writers.html5.HTMLTranslator.highlightlang()`` + - 1.8 + - 3.0 + - N/A + + * - ``sphinx.writers.html5.HTMLTranslator.highlightlang_base()`` + - 1.8 + - 3.0 + - N/A + + * - ``sphinx.writers.html5.HTMLTranslator.highlightlangopts()`` + - 1.8 + - 3.0 + - N/A + + * - ``sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold()`` + - 1.8 + - 3.0 + - N/A + * - ``sphinx.application.CONFIG_FILENAME`` - 1.8 - 3.0 diff --git a/sphinx/application.py b/sphinx/application.py index 2bf40e115..0f887b2a5 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -96,6 +96,7 @@ builtin_extensions = ( 'sphinx.registry', 'sphinx.roles', 'sphinx.transforms.post_transforms', + 'sphinx.transforms.post_transforms.code', 'sphinx.transforms.post_transforms.images', 'sphinx.transforms.post_transforms.compat', 'sphinx.util.compat', diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py new file mode 100644 index 000000000..f0c1d0097 --- /dev/null +++ b/sphinx/transforms/post_transforms/code.py @@ -0,0 +1,106 @@ +# -*- coding: utf-8 -*- +""" + sphinx.transforms.post_transforms.code + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + transforms for code-blocks. + + :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + +import sys +from typing import NamedTuple + +from docutils import nodes +from six import text_type + +from sphinx import addnodes +from sphinx.transforms import SphinxTransform + +if False: + # For type annotation + from typing import Any, Dict, List # NOQA + from sphinx.application import Sphinx # NOQA + + +HighlightSetting = NamedTuple('HighlightSetting', [('language', text_type), + ('lineno_threshold', int)]) + + +class HighlightLanguageTransform(SphinxTransform): + """ + Apply highlight_language to all literal_block nodes. + + This refers both :confval:`highlight_language` setting and + :rst:dir:`highlightlang` directive. After processing, this transform + removes ``highlightlang`` node from doctree. + """ + default_priority = 400 + + def apply(self): + visitor = HighlightLanguageVisitor(self.document, + self.config.highlight_language) + self.document.walkabout(visitor) + + for node in self.document.traverse(addnodes.highlightlang): + node.parent.remove(node) + + +class HighlightLanguageVisitor(nodes.NodeVisitor): + def __init__(self, document, default_language): + # type: (nodes.document, unicode) -> None + self.default_setting = HighlightSetting(default_language, sys.maxsize) + self.settings = [] # type: List[HighlightSetting] + nodes.NodeVisitor.__init__(self, document) + + def unknown_visit(self, node): + # type: (nodes.Node) -> None + pass + + def unknown_departure(self, node): + # type: (nodes.Node) -> None + pass + + def visit_document(self, node): + # type: (nodes.Node) -> None + self.settings.append(self.default_setting) + + def depart_document(self, node): + # type: (nodes.Node) -> None + self.settings.pop() + + def visit_start_of_file(self, node): + # type: (nodes.Node) -> None + self.settings.append(self.default_setting) + + def depart_start_of_file(self, node): + # type: (nodes.Node) -> None + self.settings.pop() + + def visit_highlightlang(self, node): + # type: (addnodes.highlightlang) -> None + self.settings[-1] = HighlightSetting(node['lang'], node['linenothreshold']) + + def visit_literal_block(self, node): + # type: (nodes.literal_block) -> None + setting = self.settings[-1] + if 'language' not in node: + node['language'] = setting.language + node['force_highlighting'] = False + else: + node['force_highlighting'] = True + if 'linenos' not in node: + lines = node.astext().count('\n') + node['linenos'] = (lines >= setting.lineno_threshold - 1) + + +def setup(app): + # type: (Sphinx) -> Dict[unicode, Any] + app.add_post_transform(HighlightLanguageTransform) + + return { + 'version': 'builtin', + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index 0586636df..1a2da99d2 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -13,12 +13,14 @@ import copy import os import posixpath import sys +import warnings from docutils import nodes from docutils.writers.html4css1 import Writer, HTMLTranslator as BaseTranslator from six import string_types from sphinx import addnodes +from sphinx.deprecation import RemovedInSphinx30Warning from sphinx.locale import admonitionlabels, _, __ from sphinx.util import logging from sphinx.util.images import get_image_size @@ -74,10 +76,6 @@ class HTMLTranslator(BaseTranslator): BaseTranslator.__init__(self, *args, **kwds) self.highlighter = builder.highlighter self.builder = builder - self.highlightlang = self.highlightlang_base = \ - builder.config.highlight_language - self.highlightopts = builder.config.highlight_options - self.highlightlinenothreshold = sys.maxsize self.docnames = [builder.current_docname] # for singlehtml builder self.manpages_url = builder.config.manpages_url self.protect_literal_text = 0 @@ -423,19 +421,14 @@ class HTMLTranslator(BaseTranslator): if node.rawsource != node.astext(): # most probably a parsed-literal block -- don't highlight return BaseTranslator.visit_literal_block(self, node) - lang = self.highlightlang - linenos = node.rawsource.count('\n') >= \ - self.highlightlinenothreshold - 1 + + lang = node.get('language', 'default') + linenos = node.get('linenos', False) highlight_args = node.get('highlight_args', {}) - if 'language' in node: - # code-block directives - lang = node['language'] - highlight_args['force'] = True - if 'linenos' in node: - linenos = node['linenos'] - if lang is self.highlightlang_base: + highlight_args['force'] = node.get('force_highlighting', False) + if lang is self.builder.config.highlight_language: # only pass highlighter options for original language - opts = self.highlightopts + opts = self.builder.config.highlight_options else: opts = {} @@ -569,15 +562,6 @@ class HTMLTranslator(BaseTranslator): # type: (nodes.Node) -> None pass - def visit_highlightlang(self, node): - # type: (nodes.Node) -> None - self.highlightlang = node['lang'] - self.highlightlinenothreshold = node['linenothreshold'] - - def depart_highlightlang(self, node): - # type: (nodes.Node) -> None - pass - def visit_download_reference(self, node): # type: (nodes.Node) -> None if self.builder.download_support and node.hasattr('filename'): @@ -883,3 +867,33 @@ class HTMLTranslator(BaseTranslator): def unknown_visit(self, node): # type: (nodes.Node) -> None raise NotImplementedError('Unknown node: ' + node.__class__.__name__) + + # --------- METHODS FOR COMPATIBILITY -------------------------------------- + + @property + def highlightlang(self): + # type: () -> unicode + warnings.warn('HTMLTranslator.highlightlang is deprecated.', + RemovedInSphinx30Warning) + return self.builder.config.highlight_language + + @property + def highlightlang_base(self): + # type: () -> unicode + warnings.warn('HTMLTranslator.highlightlang_base is deprecated.', + RemovedInSphinx30Warning) + return self.builder.config.highlight_language + + @property + def highlightopts(self): + # type: () -> unicode + warnings.warn('HTMLTranslator.highlightopts is deprecated.', + RemovedInSphinx30Warning) + return self.builder.config.highlight_options + + @property + def highlightlinenothreshold(self): + # type: () -> int + warnings.warn('HTMLTranslator.highlightlinenothreshold is deprecated.', + RemovedInSphinx30Warning) + return sys.maxsize diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 85a7ef7c2..de2591985 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -12,12 +12,14 @@ import os import posixpath import sys +import warnings from docutils import nodes from docutils.writers.html5_polyglot import HTMLTranslator as BaseTranslator from six import string_types from sphinx import addnodes +from sphinx.deprecation import RemovedInSphinx30Warning from sphinx.locale import admonitionlabels, _, __ from sphinx.util import logging from sphinx.util.images import get_image_size @@ -44,10 +46,6 @@ class HTML5Translator(BaseTranslator): BaseTranslator.__init__(self, *args, **kwds) self.highlighter = builder.highlighter self.builder = builder - self.highlightlang = self.highlightlang_base = \ - builder.config.highlight_language - self.highlightopts = builder.config.highlight_options - self.highlightlinenothreshold = sys.maxsize self.docnames = [builder.current_docname] # for singlehtml builder self.manpages_url = builder.config.manpages_url self.protect_literal_text = 0 @@ -369,19 +367,14 @@ class HTML5Translator(BaseTranslator): if node.rawsource != node.astext(): # most probably a parsed-literal block -- don't highlight return BaseTranslator.visit_literal_block(self, node) - lang = self.highlightlang - linenos = node.rawsource.count('\n') >= \ - self.highlightlinenothreshold - 1 + + lang = node.get('language', 'default') + linenos = node.get('linenos', False) highlight_args = node.get('highlight_args', {}) - if 'language' in node: - # code-block directives - lang = node['language'] - highlight_args['force'] = True - if 'linenos' in node: - linenos = node['linenos'] - if lang is self.highlightlang_base: + highlight_args['force'] = node.get('force_highlighting', False) + if lang is self.builder.config.highlight_language: # only pass highlighter options for original language - opts = self.highlightopts + opts = self.builder.config.highlight_options else: opts = {} @@ -515,15 +508,6 @@ class HTML5Translator(BaseTranslator): # type: (nodes.Node) -> None pass - def visit_highlightlang(self, node): - # type: (nodes.Node) -> None - self.highlightlang = node['lang'] - self.highlightlinenothreshold = node['linenothreshold'] - - def depart_highlightlang(self, node): - # type: (nodes.Node) -> None - pass - def visit_download_reference(self, node): # type: (nodes.Node) -> None if self.builder.download_support and node.hasattr('filename'): @@ -834,3 +818,33 @@ class HTML5Translator(BaseTranslator): def unknown_visit(self, node): # type: (nodes.Node) -> None raise NotImplementedError('Unknown node: ' + node.__class__.__name__) + + # --------- METHODS FOR COMPATIBILITY -------------------------------------- + + @property + def highlightlang(self): + # type: () -> unicode + warnings.warn('HTMLTranslator.highlightlang is deprecated.', + RemovedInSphinx30Warning) + return self.builder.config.highlight_language + + @property + def highlightlang_base(self): + # type: () -> unicode + warnings.warn('HTMLTranslator.highlightlang_base is deprecated.', + RemovedInSphinx30Warning) + return self.builder.config.highlight_language + + @property + def highlightopts(self): + # type: () -> unicode + warnings.warn('HTMLTranslator.highlightopts is deprecated.', + RemovedInSphinx30Warning) + return self.builder.config.highlight_options + + @property + def highlightlinenothreshold(self): + # type: () -> int + warnings.warn('HTMLTranslator.highlightlinenothreshold is deprecated.', + RemovedInSphinx30Warning) + return sys.maxsize diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 9a7d58116..c657664af 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -704,12 +704,6 @@ class LaTeXTranslator(nodes.NodeVisitor): self.descstack = [] # type: List[unicode] self.table = None # type: Table self.next_table_colspec = None # type: unicode - # stack of [language, linenothreshold] settings per file - # the first item here is the default and must not be changed - # the second item is the default for the master file and can be changed - # by .. highlight:: directive in the master file - self.hlsettingstack = 2 * [[builder.config.highlight_language, - sys.maxsize]] self.bodystack = [] # type: List[List[unicode]] self.footnote_restricted = False self.pending_footnotes = [] # type: List[nodes.footnote_reference] @@ -945,8 +939,6 @@ class LaTeXTranslator(nodes.NodeVisitor): def visit_start_of_file(self, node): # type: (nodes.Node) -> None self.curfilestack.append(node['docname']) - # use default highlight settings for new file - self.hlsettingstack.append(self.hlsettingstack[0]) def collect_footnotes(self, node): # type: (nodes.Node) -> Dict[unicode, List[Union[collected_footnote, bool]]] @@ -971,12 +963,6 @@ class LaTeXTranslator(nodes.NodeVisitor): def depart_start_of_file(self, node): # type: (nodes.Node) -> None self.curfilestack.pop() - self.hlsettingstack.pop() - - def visit_highlightlang(self, node): - # type: (nodes.Node) -> None - self.hlsettingstack[-1] = [node['lang'], node['linenothreshold']] - raise nodes.SkipNode def visit_section(self, node): # type: (nodes.Node) -> None @@ -2246,26 +2232,18 @@ class LaTeXTranslator(nodes.NodeVisitor): if labels and not self.in_footnote: self.body.append('\n\\def\\sphinxLiteralBlockLabel{' + labels + '}') - code = node.astext() - lang = self.hlsettingstack[-1][0] - linenos = code.count('\n') >= self.hlsettingstack[-1][1] - 1 + lang = node.get('language', 'default') + linenos = node.get('linenos', False) highlight_args = node.get('highlight_args', {}) - hllines = '\\fvset{hllines={, %s,}}%%' %\ - str(highlight_args.get('hl_lines', []))[1:-1] - if 'language' in node: - # code-block directives - lang = node['language'] - highlight_args['force'] = True - if 'linenos' in node: - linenos = node['linenos'] - if lang is self.hlsettingstack[0][0]: + highlight_args['force'] = node.get('force_highlighting', False) + if lang is self.builder.config.highlight_language: # only pass highlighter options for original language opts = self.builder.config.highlight_options else: opts = {} hlcode = self.highlighter.highlight_block( - code, lang, opts=opts, linenos=linenos, + node.rawsource, lang, opts=opts, linenos=linenos, location=(self.curfilestack[-1], node.line), **highlight_args ) # workaround for Unicode issue @@ -2290,6 +2268,9 @@ class LaTeXTranslator(nodes.NodeVisitor): hlcode += '\\end{sphinxVerbatimintable}' else: hlcode += '\\end{sphinxVerbatim}' + + hllines = '\\fvset{hllines={, %s,}}%%' %\ + str(highlight_args.get('hl_lines', []))[1:-1] self.body.append('\n' + hllines + '\n' + hlcode + '\n') raise nodes.SkipNode @@ -2639,6 +2620,13 @@ class LaTeXTranslator(nodes.NodeVisitor): RemovedInSphinx30Warning) return set() + @property + def hlsettingstack(self): + # type: () -> List[List[Union[unicode, int]]] + warnings.warn('LaTeXTranslator.hlsettingstack is deprecated.', + RemovedInSphinx30Warning) + return [[self.builder.config.highlight_language, sys.maxsize]] + # Import old modules here for compatibility # They should be imported after `LaTeXTranslator` to avoid recursive import. diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 02540a53d..45a800533 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -378,14 +378,6 @@ class ManualPageTranslator(BaseTranslator): # type: (nodes.Node) -> None pass - def visit_highlightlang(self, node): - # type: (nodes.Node) -> None - pass - - def depart_highlightlang(self, node): - # type: (nodes.Node) -> None - pass - def visit_download_reference(self, node): # type: (nodes.Node) -> None pass diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index 4f76c6cf9..6b7ec5932 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -1533,14 +1533,6 @@ class TexinfoTranslator(nodes.NodeVisitor): self.body.append('\n\n') raise nodes.SkipNode - def visit_highlightlang(self, node): - # type: (nodes.Node) -> None - pass - - def depart_highlightlang(self, node): - # type: (nodes.Node) -> None - pass - # -- Desc def visit_desc(self, node): diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 0f9b45fbe..912d87399 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -251,10 +251,6 @@ class TextTranslator(nodes.NodeVisitor): for line in lines) # XXX header/footer? - def visit_highlightlang(self, node): - # type: (nodes.Node) -> None - raise nodes.SkipNode - def visit_section(self, node): # type: (nodes.Node) -> None self._title_char = self.sectionchars[self.sectionlevel] From f3019ee1974fda0722a71c8159ab97c4e78779dd Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 21 Jul 2018 11:25:54 +0900 Subject: [PATCH 028/174] Apply :confval:`trim_doctest_flags` to all builders (cf. text, manpages) --- CHANGES | 3 ++ doc/extdev/index.rst | 6 +++ sphinx/builders/html.py | 3 +- sphinx/builders/latex/__init__.py | 3 +- sphinx/highlighting.py | 8 +++- sphinx/transforms/post_transforms/code.py | 44 +++++++++++++++++++ sphinx/writers/latex.py | 4 +- ...> test_transforms_post_transforms_code.py} | 4 +- 8 files changed, 64 insertions(+), 11 deletions(-) rename tests/{test_config_trim_doctest_flags.py => test_transforms_post_transforms_code.py} (90%) diff --git a/CHANGES b/CHANGES index e5d143104..1efe974fb 100644 --- a/CHANGES +++ b/CHANGES @@ -113,6 +113,8 @@ Deprecated * ``sphinx.ext.mathbase.is_in_section_title()`` is deprecated * ``sphinx.ext.mathbase.MathDomain`` is deprecated * ``sphinx.highlighting.PygmentsBridge.unhighlight()`` is deprecated +* The ``trim_doctest_flags`` argument of ``sphinx.highlighting.PygmentsBridge`` + is deprecated For more details, see `deprecation APIs list `_ @@ -173,6 +175,7 @@ Features added if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter * #5122: setuptools: support nitpicky option +* Apply :confval:`trim_doctest_flags` to all builders (cf. text, manpages) Bugs fixed ---------- diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index fe0d1b97e..a18534714 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -136,6 +136,12 @@ The following is a list of deprecated interface. - 3.0 - N/A + * - ``trim_doctest_flags`` arguments of + ``sphinx.highlighting.PygmentsBridge`` + - 1.8 + - 3.0 + - N/A + * - ``sphinx.ext.mathbase.MathDomain`` - 1.8 - 3.0 diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index 16587fd18..67107ba0a 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -386,8 +386,7 @@ class StandaloneHTMLBuilder(Builder): style = self.theme.get_config('theme', 'pygments_style', 'none') else: style = 'sphinx' - self.highlighter = PygmentsBridge('html', style, - self.config.trim_doctest_flags) + self.highlighter = PygmentsBridge('html', style) def init_css_files(self): # type: () -> None diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index c17ead5c2..c4e92ae5b 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -169,8 +169,7 @@ class LaTeXBuilder(Builder): def write_stylesheet(self): # type: () -> None - highlighter = highlighting.PygmentsBridge( - 'latex', self.config.pygments_style, self.config.trim_doctest_flags) + highlighter = highlighting.PygmentsBridge('latex', self.config.pygments_style) stylesheet = path.join(self.outdir, 'sphinxhighlight.sty') with open(stylesheet, 'w') as f: f.write('\\NeedsTeXFormat{LaTeX2e}[1995/12/01]\n') diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index f31ff88cc..b344dc16b 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -68,7 +68,7 @@ class PygmentsBridge(object): html_formatter = HtmlFormatter latex_formatter = LatexFormatter - def __init__(self, dest='html', stylename='sphinx', trim_doctest_flags=False): + def __init__(self, dest='html', stylename='sphinx', trim_doctest_flags=None): # type: (unicode, unicode, bool) -> None self.dest = dest if stylename is None or stylename == 'sphinx': @@ -81,7 +81,6 @@ class PygmentsBridge(object): stylename) else: style = get_style_by_name(stylename) - self.trim_doctest_flags = trim_doctest_flags self.formatter_args = {'style': style} # type: Dict[unicode, Any] if dest == 'html': self.formatter = self.html_formatter @@ -89,6 +88,11 @@ class PygmentsBridge(object): self.formatter = self.latex_formatter self.formatter_args['commandprefix'] = 'PYG' + self.trim_doctest_flags = trim_doctest_flags + if trim_doctest_flags is not None: + warnings.warn('trim_doctest_flags option for PygmentsBridge is now deprecated.', + RemovedInSphinx30Warning) + def get_formatter(self, **kwargs): # type: (Any) -> Formatter kwargs.update(self.formatter_args) # type: ignore diff --git a/sphinx/transforms/post_transforms/code.py b/sphinx/transforms/post_transforms/code.py index f0c1d0097..86143ffb4 100644 --- a/sphinx/transforms/post_transforms/code.py +++ b/sphinx/transforms/post_transforms/code.py @@ -13,9 +13,11 @@ import sys from typing import NamedTuple from docutils import nodes +from pygments.lexers import PythonConsoleLexer, guess_lexer from six import text_type from sphinx import addnodes +from sphinx.ext import doctest from sphinx.transforms import SphinxTransform if False: @@ -95,9 +97,51 @@ class HighlightLanguageVisitor(nodes.NodeVisitor): node['linenos'] = (lines >= setting.lineno_threshold - 1) +class TrimDoctestFlagsTransform(SphinxTransform): + """ + Trim doctest flags like ``# doctest: +FLAG`` from python code-blocks. + + see :confval:`trim_doctest_flags` for more information. + """ + default_priority = HighlightLanguageTransform.default_priority + 1 + + def apply(self): + if not self.config.trim_doctest_flags: + return + + for node in self.document.traverse(nodes.literal_block): + if self.is_pyconsole(node): + source = node.rawsource + source = doctest.blankline_re.sub('', source) + source = doctest.doctestopt_re.sub('', source) + node.rawsource = source + node[:] = [nodes.Text(source)] + + @staticmethod + def is_pyconsole(node): + # type: (nodes.literal_block) -> bool + if node.rawsource != node.astext(): + return False # skip parsed-literal node + + language = node.get('language') + if language in ('pycon', 'pycon3'): + return True + elif language in ('py', 'py3', 'python', 'python3', 'default'): + return node.rawsource.startswith('>>>') + elif language == 'guess': + try: + lexer = guess_lexer(node.rawsource) + return isinstance(lexer, PythonConsoleLexer) + except Exception: + pass + + return False + + def setup(app): # type: (Sphinx) -> Dict[unicode, Any] app.add_post_transform(HighlightLanguageTransform) + app.add_post_transform(TrimDoctestFlagsTransform) return { 'version': 'builtin', diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index c657664af..b7d80860b 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -697,9 +697,7 @@ class LaTeXTranslator(nodes.NodeVisitor): self.babel_defmacro('\\pageautorefname', self.encode(_('page'))) self.elements['numfig_format'] = self.generate_numfig_format(builder) - self.highlighter = highlighting.PygmentsBridge( - 'latex', - builder.config.pygments_style, builder.config.trim_doctest_flags) + self.highlighter = highlighting.PygmentsBridge('latex', builder.config.pygments_style) self.context = [] # type: List[Any] self.descstack = [] # type: List[unicode] self.table = None # type: Table diff --git a/tests/test_config_trim_doctest_flags.py b/tests/test_transforms_post_transforms_code.py similarity index 90% rename from tests/test_config_trim_doctest_flags.py rename to tests/test_transforms_post_transforms_code.py index 3be1b27a2..e1c45ce65 100644 --- a/tests/test_config_trim_doctest_flags.py +++ b/tests/test_transforms_post_transforms_code.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """ - test_config_trim_doctest_flags - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + test_transforms_post_transforms_code + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. From c0ba51902f943c6f5cae56429fb0c73652ce1d21 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 21 Jul 2018 14:35:31 +0900 Subject: [PATCH 029/174] Fix #5198: document not in toctree warning when including files only for parallel builds --- CHANGES | 3 +++ sphinx/environment/__init__.py | 3 +++ 2 files changed, 6 insertions(+) diff --git a/CHANGES b/CHANGES index f0133ff94..778df02e0 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,9 @@ Features added Bugs fixed ---------- +* #5198: document not in toctree warning when including files only for parallel + builds + Testing -------- diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index 86d69cc3a..4d3935faf 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -310,6 +310,7 @@ class BuildEnvironment(object): if docname in self.all_docs: self.all_docs.pop(docname, None) self.reread_always.discard(docname) + self.included.discard(docname) for version, changes in self.versionchanges.items(): new = [change for change in changes if change[1] != docname] @@ -330,6 +331,8 @@ class BuildEnvironment(object): self.all_docs[docname] = other.all_docs[docname] if docname in other.reread_always: self.reread_always.add(docname) + if docname in other.included: + self.included.add(docname) for version, changes in other.versionchanges.items(): self.versionchanges.setdefault(version, []).extend( From fe3d4ddc20828207ea6b1d0cdc387108a167d3c9 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 22 Jul 2018 00:03:17 +0900 Subject: [PATCH 030/174] Fix classic theme: collapsiblesidebar is always enabled --- sphinx/themes/classic/layout.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sphinx/themes/classic/layout.html b/sphinx/themes/classic/layout.html index 8042e3f7e..bee2ffd1e 100644 --- a/sphinx/themes/classic/layout.html +++ b/sphinx/themes/classic/layout.html @@ -9,9 +9,9 @@ #} {%- extends "basic/layout.html" %} -{% if theme_collapsiblesidebar|tobool %} {%- block scripts %} {{ super() }} + {% if theme_collapsiblesidebar|tobool %} + {% endif %} {%- endblock %} -{% endif %} From d0900001afab78dc9d8cb2356e82be8eae161863 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 22 Jul 2018 00:09:11 +0900 Subject: [PATCH 031/174] doc: collapsiblesidebar works well with stickysidebar --- doc/theming.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/theming.rst b/doc/theming.rst index fccc2362e..3308fe632 100644 --- a/doc/theming.rst +++ b/doc/theming.rst @@ -150,7 +150,7 @@ These themes are: - **collapsiblesidebar** (true or false): Add an *experimental* JavaScript snippet that makes the sidebar collapsible via a button on its side. - *Doesn't work with "stickysidebar".* Defaults to ``False``. + Defaults to ``False``. - **externalrefs** (true or false): Display external links differently from internal links. Defaults to ``False``. From 8c29801f271eb7c258924fef02609d1b8d9d1d25 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 22 Jul 2018 01:06:17 +0900 Subject: [PATCH 032/174] Close #2820: autoclass directive supports nested class --- CHANGES | 1 + sphinx/ext/autodoc/importer.py | 17 +++++++++++++++-- tests/test_autodoc.py | 3 +++ 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index e57a0dad6..114c34cf5 100644 --- a/CHANGES +++ b/CHANGES @@ -162,6 +162,7 @@ Features added if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter * #5122: setuptools: support nitpicky option +* #2820: autoclass directive supports nested class Bugs fixed ---------- diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py index 20d448506..4b92a7b59 100644 --- a/sphinx/ext/autodoc/importer.py +++ b/sphinx/ext/autodoc/importer.py @@ -167,8 +167,21 @@ def import_object(modname, objpath, objtype='', attrgetter=safe_getattr, warning logger.debug('[autodoc] import %s', modname) try: - module = import_module(modname, warningiserror=warningiserror) - logger.debug('[autodoc] => %r', module) + module = None + objpath = list(objpath) + while module is None: + try: + module = import_module(modname, warningiserror=warningiserror) + logger.debug('[autodoc] import %s => %r', modname, module) + except ImportError: + logger.debug('[autodoc] import %s => failed', modname) + if '.' in modname: + # retry with parent module + modname, name = modname.rsplit('.', 1) + objpath.insert(0, name) + else: + raise + obj = module parent = None object_name = None diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 53d8a1e14..a42210a4c 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -771,6 +771,9 @@ def test_generate(): ('class', 'target.Outer.Inner'), ('method', 'target.Outer.Inner.meth')], 'class', 'Outer', all_members=True) + assert_processes([('class', 'target.Outer.Inner'), + ('method', 'target.Outer.Inner.meth')], + 'class', 'target.Outer.Inner', all_members=True) # test descriptor docstrings assert_result_contains(' Descriptor instance docstring.', From cfc56329d4453c37bc3d0b8e7ea8813c10e1a7c6 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 22 Jul 2018 01:50:09 +0900 Subject: [PATCH 033/174] Fix #344: autosummary does not understand docstring of module level attributes --- CHANGES | 1 + sphinx/ext/autodoc/__init__.py | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/CHANGES b/CHANGES index e57a0dad6..92475536c 100644 --- a/CHANGES +++ b/CHANGES @@ -174,6 +174,7 @@ Bugs fixed * #5132: (lualatex) PDF build fails if indexed word starts with Unicode character * #5133: latex: index headings "Symbols" and "Numbers" not internationalized * #5114: sphinx-build: Handle errors on scanning documents +* #344: autosummary does not understand docstring of module level attributes Testing -------- diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 62143fda4..4a9b59537 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1265,6 +1265,11 @@ class DataDocumenter(ModuleLevelDocumenter): # type: (bool) -> None pass + def get_real_modname(self): + # type: () -> str + return self.get_attr(self.parent or self.object, '__module__', None) \ + or self.modname + class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): # type: ignore """ From d2a15f403525f65f96b7efa40c12c73dabfa877e Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sat, 21 Jul 2018 20:17:00 +0200 Subject: [PATCH 034/174] #5186 clean up JavaScript templates: doctools move templating from `doctools` to `documentation_options` --- sphinx/themes/basic/static/{doctools.js_t => doctools.js} | 6 +++--- sphinx/themes/basic/static/documentation_options.js_t | 3 ++- 2 files changed, 5 insertions(+), 4 deletions(-) rename sphinx/themes/basic/static/{doctools.js_t => doctools.js} (98%) diff --git a/sphinx/themes/basic/static/doctools.js_t b/sphinx/themes/basic/static/doctools.js similarity index 98% rename from sphinx/themes/basic/static/doctools.js_t rename to sphinx/themes/basic/static/doctools.js index 1dca47404..ffadbec11 100644 --- a/sphinx/themes/basic/static/doctools.js_t +++ b/sphinx/themes/basic/static/doctools.js @@ -150,9 +150,9 @@ var Documentation = { this.fixFirefoxAnchorBug(); this.highlightSearchWords(); this.initIndexTable(); - {% if theme_navigation_with_keys|tobool %} - this.initOnKeyListeners(); - {% endif %} + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } }, /** diff --git a/sphinx/themes/basic/static/documentation_options.js_t b/sphinx/themes/basic/static/documentation_options.js_t index 9da9801a1..66d4bab88 100644 --- a/sphinx/themes/basic/static/documentation_options.js_t +++ b/sphinx/themes/basic/static/documentation_options.js_t @@ -5,5 +5,6 @@ var DOCUMENTATION_OPTIONS = { COLLAPSE_INDEX: false, FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}', HAS_SOURCE: {{ has_source|lower }}, - SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}' + SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}', + NAVIGATION_WITH_KEYS: {{ 'true' if theme_navigation_with_keys|tobool else 'false'}} }; From 67cb316ba2ceb4459ca7fd06129c3b6e3b83c8fc Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sun, 22 Jul 2018 11:01:28 +0200 Subject: [PATCH 035/174] move templating from `searchtools` to `documentation_options` --- .../basic/static/documentation_options.js_t | 16 +++- .../{searchtools.js_t => searchtools.js} | 78 +++++++++---------- 2 files changed, 50 insertions(+), 44 deletions(-) rename sphinx/themes/basic/static/{searchtools.js_t => searchtools.js} (91%) diff --git a/sphinx/themes/basic/static/documentation_options.js_t b/sphinx/themes/basic/static/documentation_options.js_t index 66d4bab88..bd32e356b 100644 --- a/sphinx/themes/basic/static/documentation_options.js_t +++ b/sphinx/themes/basic/static/documentation_options.js_t @@ -6,5 +6,19 @@ var DOCUMENTATION_OPTIONS = { FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}', HAS_SOURCE: {{ has_source|lower }}, SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}', - NAVIGATION_WITH_KEYS: {{ 'true' if theme_navigation_with_keys|tobool else 'false'}} + NAVIGATION_WITH_KEYS: {{ 'true' if theme_navigation_with_keys|tobool else 'false'}}, + SEARCH_LANGUAGE_STOP_WORDS: {{ search_language_stop_words }} }; + + +{% if search_language_stemming_code %} +/* Non-minified version JS is _stemmer.js if file is provided */ {% endif -%} +{{ search_language_stemming_code|safe }} + +{% if search_scorer_tool %} +{{ search_scorer_tool|safe }} +{% endif -%} + +{% if search_word_splitter_code %} +{{ search_word_splitter_code }} +{% endif -%} diff --git a/sphinx/themes/basic/static/searchtools.js_t b/sphinx/themes/basic/static/searchtools.js similarity index 91% rename from sphinx/themes/basic/static/searchtools.js_t rename to sphinx/themes/basic/static/searchtools.js index e707bb1ea..34d7db2e3 100644 --- a/sphinx/themes/basic/static/searchtools.js_t +++ b/sphinx/themes/basic/static/searchtools.js @@ -9,51 +9,43 @@ * */ -{% if search_language_stemming_code %} -/* Non-minified version JS is _stemmer.js if file is provided */ {% endif -%} -{{ search_language_stemming_code|safe }} +if (!Scorer) { + /** + * Simple result scoring code. + */ + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [filename, title, anchor, descr, score] + // and returns the new score. + /* + score: function(result) { + return result[4]; + }, + */ -{% if search_scorer_tool %} -{{ search_scorer_tool|safe }} -{% else %} -/** - * Simple result scoring code. - */ -var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [filename, title, anchor, descr, score] - // and returns the new score. - /* - score: function(result) { - return result[4]; - }, - */ + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: {0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5}, // used to be unimportantResults + // Used when the priority is not in the mapping. + objPrioDefault: 0, - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: {0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5}, // used to be unimportantResults - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - // query found in terms - term: 5 -}; -{% endif %} - -{% if search_word_splitter_code %} -{{ search_word_splitter_code }} -{% else %} -function splitQuery(query) { - return query.split(/\s+/); + // query found in title + title: 15, + // query found in terms + term: 5 + }; +} + +if (!splitQuery) { + function splitQuery(query) { + return query.split(/\s+/); + } } -{% endif %} /** * Search Module @@ -146,7 +138,7 @@ var Search = { */ query : function(query) { var i; - var stopwords = {{ search_language_stop_words }}; + var stopwords = DOCUMENTATION_OPTIONS.SEARCH_LANGUAGE_STOP_WORDS; // stem the searchterms and add them to the correct list var stemmer = new Stemmer(); From 732ebb5d1e5a2114870525a8a789ec39df19bcfb Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Sat, 21 Jul 2018 23:13:16 +0200 Subject: [PATCH 036/174] Capitalization: "Table Of Contents" -> "Table of Contents". This is consistent with "Complete Table of Contents" (which is already in the database), as well as e.g. "Indices and Tables" where "and" is not capitalized. This is also fairly standard title-case practice. --- sphinx/themes/agogo/layout.html | 2 +- sphinx/themes/basic/globaltoc.html | 2 +- sphinx/themes/basic/localtoc.html | 2 +- sphinx/themes/haiku/layout.html | 2 +- sphinx/themes/scrolls/layout.html | 2 +- tests/test_theming.py | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sphinx/themes/agogo/layout.html b/sphinx/themes/agogo/layout.html index 8bd476cad..f2c880537 100644 --- a/sphinx/themes/agogo/layout.html +++ b/sphinx/themes/agogo/layout.html @@ -43,7 +43,7 @@
{%- block sidebartoc %} -

{{ _('Table Of Contents') }}

+

{{ _('Table of Contents') }}

{{ toctree() }} {%- endblock %} {%- block sidebarsearch %} diff --git a/sphinx/themes/basic/globaltoc.html b/sphinx/themes/basic/globaltoc.html index dc6fea373..7671a93ca 100644 --- a/sphinx/themes/basic/globaltoc.html +++ b/sphinx/themes/basic/globaltoc.html @@ -7,5 +7,5 @@ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} -

{{ _('Table Of Contents') }}

+

{{ _('Table of Contents') }}

{{ toctree() }} diff --git a/sphinx/themes/basic/localtoc.html b/sphinx/themes/basic/localtoc.html index 5d3c7f4fd..d4cc9e31d 100644 --- a/sphinx/themes/basic/localtoc.html +++ b/sphinx/themes/basic/localtoc.html @@ -8,6 +8,6 @@ :license: BSD, see LICENSE for details. #} {%- if display_toc %} -

{{ _('Table Of Contents') }}

+

{{ _('Table of Contents') }}

{{ toc }} {%- endif %} diff --git a/sphinx/themes/haiku/layout.html b/sphinx/themes/haiku/layout.html index c93c52dbd..c3c79c4d6 100644 --- a/sphinx/themes/haiku/layout.html +++ b/sphinx/themes/haiku/layout.html @@ -54,7 +54,7 @@
{#{%- if display_toc %}
-

{{ _('Table Of Contents') }}

+

{{ _('Table of Contents') }}

{{ toc }}
{%- endif %}#} diff --git a/sphinx/themes/scrolls/layout.html b/sphinx/themes/scrolls/layout.html index 7bb7b19e3..0f9232a00 100644 --- a/sphinx/themes/scrolls/layout.html +++ b/sphinx/themes/scrolls/layout.html @@ -38,7 +38,7 @@
{%- if display_toc %} {%- endif %} diff --git a/tests/test_theming.py b/tests/test_theming.py index 8c09271e3..43e97473d 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -124,7 +124,7 @@ def test_theme_sidebars(app, status, warning): # test-theme specifies globaltoc and searchbox as default sidebars result = (app.outdir / 'index.html').text(encoding='utf8') - assert '

Table Of Contents

' in result + assert '

Table of Contents

' in result assert '

Related Topics

' not in result assert '

This Page

' not in result assert '

Quick search

' in result From 5fdf81fe2dc7f377d08e231ac6018061a2a16ed0 Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sun, 22 Jul 2018 12:27:39 +0200 Subject: [PATCH 037/174] #5186 configure karma and add first karma test --- .gitignore | 2 + karma.conf.js | 72 + package-lock.json | 4456 ++++++++++++++++++++++++++++++++++++++++++ package.json | 20 + tests/js/doctools.js | 12 + 5 files changed, 4562 insertions(+) create mode 100644 karma.conf.js create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 tests/js/doctools.js diff --git a/.gitignore b/.gitignore index 3e515ddab..d5dc0b030 100644 --- a/.gitignore +++ b/.gitignore @@ -29,3 +29,5 @@ doc/locale/ tests/.coverage tests/build/ utils/regression_test.js + +node_modules/ diff --git a/karma.conf.js b/karma.conf.js new file mode 100644 index 000000000..d0c11aa21 --- /dev/null +++ b/karma.conf.js @@ -0,0 +1,72 @@ +// Karma configuration +// Generated on Sat Jul 21 2018 22:01:48 GMT+0200 (CEST) + +module.exports = function(config) { + config.set({ + + // base path that will be used to resolve all patterns (eg. files, exclude) + basePath: '', + + + // frameworks to use + // available frameworks: https://npmjs.org/browse/keyword/karma-adapter + frameworks: ['jasmine'], + + + // list of files / patterns to load in the browser + files: [ + 'sphinx/themes/basic/static/underscore.js', + 'sphinx/themes/basic/static/jquery.js', + 'sphinx/themes/basic/static/doctools.js', + 'tests/js/*.js' + ], + + + // list of files / patterns to exclude + exclude: [ + ], + + + // preprocess matching files before serving them to the browser + // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor + preprocessors: { + }, + + + // test results reporter to use + // possible values: 'dots', 'progress' + // available reporters: https://npmjs.org/browse/keyword/karma-reporter + reporters: ['progress'], + + + // web server port + port: 9876, + + + // enable / disable colors in the output (reporters and logs) + colors: true, + + + // level of logging + // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG + logLevel: config.LOG_INFO, + + + // enable / disable watching file and executing tests whenever any file changes + autoWatch: true, + + + // start these browsers + // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher + browsers: ['Chrome', 'Firefox'], + + + // Continuous Integration mode + // if true, Karma captures browsers, runs the tests and exits + singleRun: false, + + // Concurrency level + // how many browser should be started simultaneous + concurrency: Infinity + }) +} diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 000000000..cc76843a2 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,4456 @@ +{ + "name": "sphinx", + "requires": true, + "lockfileVersion": 1, + "dependencies": { + "accepts": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.5.tgz", + "integrity": "sha1-63d99gEXI6OxTopywIBcjoZ0a9I=", + "dev": true, + "requires": { + "mime-types": "2.1.19", + "negotiator": "0.6.1" + } + }, + "addressparser": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/addressparser/-/addressparser-1.0.1.tgz", + "integrity": "sha1-R6++GiqSYhkdtoOOT9HTm0CCF0Y=", + "dev": true, + "optional": true + }, + "after": { + "version": "0.8.2", + "resolved": "https://registry.npmjs.org/after/-/after-0.8.2.tgz", + "integrity": "sha1-/ts5T58OAqqXaOcCvaI7UF+ufh8=", + "dev": true + }, + "agent-base": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-4.2.1.tgz", + "integrity": "sha512-JVwXMr9nHYTUXsBFKUqhJwvlcYU/blreOEUkhNR2eXZIvwd+c+o5V4MgDPKWnMS/56awN3TRzIP+KoPn+roQtg==", + "dev": true, + "requires": { + "es6-promisify": "5.0.0" + } + }, + "ajv": { + "version": "5.5.2", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-5.5.2.tgz", + "integrity": "sha1-c7Xuyj+rZT49P5Qis0GtQiBdyWU=", + "dev": true, + "optional": true, + "requires": { + "co": "4.6.0", + "fast-deep-equal": "1.1.0", + "fast-json-stable-stringify": "2.0.0", + "json-schema-traverse": "0.3.1" + } + }, + "amqplib": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/amqplib/-/amqplib-0.5.2.tgz", + "integrity": "sha512-l9mCs6LbydtHqRniRwYkKdqxVa6XMz3Vw1fh+2gJaaVgTM6Jk3o8RccAKWKtlhT1US5sWrFh+KKxsVUALURSIA==", + "dev": true, + "optional": true, + "requires": { + "bitsyntax": "0.0.4", + "bluebird": "3.5.1", + "buffer-more-ints": "0.0.2", + "readable-stream": "1.1.14", + "safe-buffer": "5.1.2" + }, + "dependencies": { + "isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", + "dev": true, + "optional": true + }, + "readable-stream": { + "version": "1.1.14", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", + "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", + "dev": true, + "optional": true, + "requires": { + "core-util-is": "1.0.2", + "inherits": "2.0.3", + "isarray": "0.0.1", + "string_decoder": "0.10.31" + } + }, + "string_decoder": { + "version": "0.10.31", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", + "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", + "dev": true, + "optional": true + } + } + }, + "ansi-regex": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", + "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", + "dev": true + }, + "ansi-styles": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", + "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4=", + "dev": true, + "optional": true + }, + "anymatch": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-2.0.0.tgz", + "integrity": "sha512-5teOsQWABXHHBFP9y3skS5P3d/WfWXpv3FUpy+LorMrNYaT9pI4oLMQX7jzQ2KklNpGpWHzdCXTDT2Y3XGlZBw==", + "dev": true, + "requires": { + "micromatch": "3.1.10", + "normalize-path": "2.1.1" + } + }, + "arr-diff": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-4.0.0.tgz", + "integrity": "sha1-1kYQdP6/7HHn4VI1dhoyml3HxSA=", + "dev": true + }, + "arr-flatten": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/arr-flatten/-/arr-flatten-1.1.0.tgz", + "integrity": "sha512-L3hKV5R/p5o81R7O02IGnwpDmkp6E982XhtbuwSe3O4qOtMMMtodicASA1Cny2U+aCXcNpml+m4dPsvsJ3jatg==", + "dev": true + }, + "arr-union": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz", + "integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ=", + "dev": true + }, + "array-slice": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/array-slice/-/array-slice-0.2.3.tgz", + "integrity": "sha1-3Tz7gO15c6dRF82sabC5nshhhvU=", + "dev": true + }, + "array-unique": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", + "integrity": "sha1-qJS3XUvE9s1nnvMkSp/Y9Gri1Cg=", + "dev": true + }, + "arraybuffer.slice": { + "version": "0.0.7", + "resolved": "https://registry.npmjs.org/arraybuffer.slice/-/arraybuffer.slice-0.0.7.tgz", + "integrity": "sha512-wGUIVQXuehL5TCqQun8OW81jGzAWycqzFF8lFp+GOM5BXLYj3bKNsYC4daB7n6XjCqxQA/qgTJ+8ANR3acjrog==", + "dev": true + }, + "asn1": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.3.tgz", + "integrity": "sha1-2sh4dxPJlmhJ/IGAd36+nB3fO4Y=", + "dev": true, + "optional": true + }, + "assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", + "dev": true + }, + "assign-symbols": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-1.0.0.tgz", + "integrity": "sha1-WWZ/QfrdTyDMvCu5a41Pf3jsA2c=", + "dev": true + }, + "ast-types": { + "version": "0.11.5", + "resolved": "https://registry.npmjs.org/ast-types/-/ast-types-0.11.5.tgz", + "integrity": "sha512-oJjo+5e7/vEc2FBK8gUalV0pba4L3VdBIs2EKhOLHLcOd2FgQIVQN9xb0eZ9IjEWyAL7vq6fGJxOvVvdCHNyMw==", + "dev": true, + "optional": true + }, + "async": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/async/-/async-2.6.1.tgz", + "integrity": "sha512-fNEiL2+AZt6AlAw/29Cr0UDe4sRAHCpEHh54WMz+Bb7QfNcFw4h3loofyJpLeQs4Yx7yuqu/2dLgM5hKOs6HlQ==", + "dev": true, + "optional": true, + "requires": { + "lodash": "4.17.10" + } + }, + "async-each": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/async-each/-/async-each-1.0.1.tgz", + "integrity": "sha1-GdOGodntxufByF04iu28xW0zYC0=", + "dev": true + }, + "async-limiter": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/async-limiter/-/async-limiter-1.0.0.tgz", + "integrity": "sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg==", + "dev": true + }, + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=", + "dev": true, + "optional": true + }, + "atob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/atob/-/atob-2.1.1.tgz", + "integrity": "sha1-ri1acpR38onWDdf5amMUoi3Wwio=", + "dev": true + }, + "aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=", + "dev": true, + "optional": true + }, + "aws4": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.7.0.tgz", + "integrity": "sha512-32NDda82rhwD9/JBCCkB+MRYDp0oSvlo2IL6rQWA10PQi7tDUM3eqMSltXmY+Oyl/7N3P3qNtAlv7X0d9bI28w==", + "dev": true, + "optional": true + }, + "axios": { + "version": "0.15.3", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.15.3.tgz", + "integrity": "sha1-LJ1jiy4ZGgjqHWzJiOrda6W9wFM=", + "dev": true, + "optional": true, + "requires": { + "follow-redirects": "1.0.0" + }, + "dependencies": { + "follow-redirects": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.0.0.tgz", + "integrity": "sha1-jjQpjL0uF28lTv/sdaHHjMhJ/Tc=", + "dev": true, + "optional": true, + "requires": { + "debug": "2.6.9" + } + } + } + }, + "backo2": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/backo2/-/backo2-1.0.2.tgz", + "integrity": "sha1-MasayLEpNjRj41s+u2n038+6eUc=", + "dev": true + }, + "balanced-match": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", + "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", + "dev": true + }, + "base": { + "version": "0.11.2", + "resolved": "https://registry.npmjs.org/base/-/base-0.11.2.tgz", + "integrity": "sha512-5T6P4xPgpp0YDFvSWwEZ4NoE3aM4QBQXDzmVbraCkFj8zHM+mba8SyqB5DbZWyR7mYHo6Y7BdQo3MoA4m0TeQg==", + "dev": true, + "requires": { + "cache-base": "1.0.1", + "class-utils": "0.3.6", + "component-emitter": "1.2.1", + "define-property": "1.0.0", + "isobject": "3.0.1", + "mixin-deep": "1.3.1", + "pascalcase": "0.1.1" + }, + "dependencies": { + "define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", + "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", + "dev": true, + "requires": { + "is-descriptor": "1.0.2" + } + }, + "is-accessor-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", + "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-data-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", + "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-descriptor": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", + "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", + "dev": true, + "requires": { + "is-accessor-descriptor": "1.0.0", + "is-data-descriptor": "1.0.0", + "kind-of": "6.0.2" + } + } + } + }, + "base64-arraybuffer": { + "version": "0.1.5", + "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.5.tgz", + "integrity": "sha1-c5JncZI7Whl0etZmqlzUv5xunOg=", + "dev": true + }, + "base64id": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/base64id/-/base64id-1.0.0.tgz", + "integrity": "sha1-R2iMuZu2gE8OBtPnY7HDLlfY5rY=", + "dev": true + }, + "bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=", + "dev": true, + "optional": true, + "requires": { + "tweetnacl": "0.14.5" + } + }, + "better-assert": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/better-assert/-/better-assert-1.0.2.tgz", + "integrity": "sha1-QIZrnhueC1W0gYlDEeaPr/rrxSI=", + "dev": true, + "requires": { + "callsite": "1.0.0" + } + }, + "binary-extensions": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-1.11.0.tgz", + "integrity": "sha1-RqoXUftqL5PuXmibsQh9SxTGwgU=", + "dev": true + }, + "bitsyntax": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/bitsyntax/-/bitsyntax-0.0.4.tgz", + "integrity": "sha1-6xDMb4K4xJDj6FaY8H6D1G4MuoI=", + "dev": true, + "optional": true, + "requires": { + "buffer-more-ints": "0.0.2" + } + }, + "bl": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/bl/-/bl-1.1.2.tgz", + "integrity": "sha1-/cqHGplxOqANGeO7ukHER4emU5g=", + "dev": true, + "optional": true, + "requires": { + "readable-stream": "2.0.6" + }, + "dependencies": { + "process-nextick-args": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-1.0.7.tgz", + "integrity": "sha1-FQ4gt1ZZCtP5EJPyWk8q2L/zC6M=", + "dev": true, + "optional": true + }, + "readable-stream": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.0.6.tgz", + "integrity": "sha1-j5A0HmilPMySh4jaz80Rs265t44=", + "dev": true, + "optional": true, + "requires": { + "core-util-is": "1.0.2", + "inherits": "2.0.3", + "isarray": "1.0.0", + "process-nextick-args": "1.0.7", + "string_decoder": "0.10.31", + "util-deprecate": "1.0.2" + } + }, + "string_decoder": { + "version": "0.10.31", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", + "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", + "dev": true, + "optional": true + } + } + }, + "blob": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/blob/-/blob-0.0.4.tgz", + "integrity": "sha1-vPEwUspURj8w+fx+lbmkdjCpSSE=", + "dev": true + }, + "bluebird": { + "version": "3.5.1", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.5.1.tgz", + "integrity": "sha512-MKiLiV+I1AA596t9w1sQJ8jkiSr5+ZKi0WKrYGUn6d1Fx+Ij4tIj+m2WMQSGczs5jZVxV339chE8iwk6F64wjA==", + "dev": true + }, + "body-parser": { + "version": "1.18.3", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.18.3.tgz", + "integrity": "sha1-WykhmP/dVTs6DyDe0FkrlWlVyLQ=", + "dev": true, + "requires": { + "bytes": "3.0.0", + "content-type": "1.0.4", + "debug": "2.6.9", + "depd": "1.1.2", + "http-errors": "1.6.3", + "iconv-lite": "0.4.23", + "on-finished": "2.3.0", + "qs": "6.5.2", + "raw-body": "2.3.3", + "type-is": "1.6.16" + } + }, + "boom": { + "version": "2.10.1", + "resolved": "https://registry.npmjs.org/boom/-/boom-2.10.1.tgz", + "integrity": "sha1-OciRjO/1eZ+D+UkqhI9iWt0Mdm8=", + "dev": true, + "requires": { + "hoek": "2.16.3" + } + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "requires": { + "balanced-match": "1.0.0", + "concat-map": "0.0.1" + } + }, + "braces": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-2.3.2.tgz", + "integrity": "sha512-aNdbnj9P8PjdXU4ybaWLK2IF3jc/EoDYbC7AazW6to3TRsfXxscC9UXOB5iDiEQrkyIbWp2SLQda4+QAa7nc3w==", + "dev": true, + "requires": { + "arr-flatten": "1.1.0", + "array-unique": "0.3.2", + "extend-shallow": "2.0.1", + "fill-range": "4.0.0", + "isobject": "3.0.1", + "repeat-element": "1.1.2", + "snapdragon": "0.8.2", + "snapdragon-node": "2.1.1", + "split-string": "3.1.0", + "to-regex": "3.0.2" + }, + "dependencies": { + "extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "dev": true, + "requires": { + "is-extendable": "0.1.1" + } + } + } + }, + "buffer-more-ints": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/buffer-more-ints/-/buffer-more-ints-0.0.2.tgz", + "integrity": "sha1-JrOIXRD6E9t/wBquOquHAZngEkw=", + "dev": true + }, + "buildmail": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/buildmail/-/buildmail-4.0.1.tgz", + "integrity": "sha1-h393OLeHKYccmhBeO4N9K+EaenI=", + "dev": true, + "optional": true, + "requires": { + "addressparser": "1.0.1", + "libbase64": "0.1.0", + "libmime": "3.0.0", + "libqp": "1.1.0", + "nodemailer-fetch": "1.6.0", + "nodemailer-shared": "1.1.0", + "punycode": "1.4.1" + } + }, + "bytes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", + "integrity": "sha1-0ygVQE1olpn4Wk6k+odV3ROpYEg=", + "dev": true + }, + "cache-base": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", + "integrity": "sha512-AKcdTnFSWATd5/GCPRxr2ChwIJ85CeyrEyjRHlKxQ56d4XJMGym0uAiKn0xbLOGOl3+yRpOTi484dVCEc5AUzQ==", + "dev": true, + "requires": { + "collection-visit": "1.0.0", + "component-emitter": "1.2.1", + "get-value": "2.0.6", + "has-value": "1.0.0", + "isobject": "3.0.1", + "set-value": "2.0.0", + "to-object-path": "0.3.0", + "union-value": "1.0.0", + "unset-value": "1.0.0" + } + }, + "callsite": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/callsite/-/callsite-1.0.0.tgz", + "integrity": "sha1-KAOY5dZkvXQDi28JBRU+borxvCA=", + "dev": true + }, + "caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=", + "dev": true, + "optional": true + }, + "chalk": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz", + "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=", + "dev": true, + "optional": true, + "requires": { + "ansi-styles": "2.2.1", + "escape-string-regexp": "1.0.5", + "has-ansi": "2.0.0", + "strip-ansi": "3.0.1", + "supports-color": "2.0.0" + } + }, + "chokidar": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-2.0.4.tgz", + "integrity": "sha512-z9n7yt9rOvIJrMhvDtDictKrkFHeihkNl6uWMmZlmL6tJtX9Cs+87oK+teBx+JIgzvbX3yZHT3eF8vpbDxHJXQ==", + "dev": true, + "requires": { + "anymatch": "2.0.0", + "async-each": "1.0.1", + "braces": "2.3.2", + "fsevents": "1.2.4", + "glob-parent": "3.1.0", + "inherits": "2.0.3", + "is-binary-path": "1.0.1", + "is-glob": "4.0.0", + "lodash.debounce": "4.0.8", + "normalize-path": "2.1.1", + "path-is-absolute": "1.0.1", + "readdirp": "2.1.0", + "upath": "1.1.0" + } + }, + "circular-json": { + "version": "0.5.5", + "resolved": "https://registry.npmjs.org/circular-json/-/circular-json-0.5.5.tgz", + "integrity": "sha512-13YaR6kiz0kBNmIVM87Io8Hp7bWOo4r61vkEANy8iH9R9bc6avud/1FT0SBpqR1RpIQADOh/Q+yHZDA1iL6ysA==", + "dev": true + }, + "class-utils": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/class-utils/-/class-utils-0.3.6.tgz", + "integrity": "sha512-qOhPa/Fj7s6TY8H8esGu5QNpMMQxz79h+urzrNYN6mn+9BnxlDGf5QZ+XeCDsxSjPqsSR56XOZOJmpeurnLMeg==", + "dev": true, + "requires": { + "arr-union": "3.1.0", + "define-property": "0.2.5", + "isobject": "3.0.1", + "static-extend": "0.1.2" + }, + "dependencies": { + "define-property": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", + "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", + "dev": true, + "requires": { + "is-descriptor": "0.1.6" + } + } + } + }, + "co": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", + "integrity": "sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=", + "dev": true, + "optional": true + }, + "collection-visit": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz", + "integrity": "sha1-S8A3PBZLwykbTTaMgpzxqApZ3KA=", + "dev": true, + "requires": { + "map-visit": "1.0.0", + "object-visit": "1.0.1" + } + }, + "colors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.3.0.tgz", + "integrity": "sha512-EDpX3a7wHMWFA7PUHWPHNWqOxIIRSJetuwl0AS5Oi/5FMV8kWm69RTlgm00GKjBO1xFHMtBbL49yRtMMdticBw==", + "dev": true + }, + "combine-lists": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/combine-lists/-/combine-lists-1.0.1.tgz", + "integrity": "sha1-RYwH4J4NkA/Ci3Cj/sLazR0st/Y=", + "dev": true, + "requires": { + "lodash": "4.17.10" + } + }, + "combined-stream": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.6.tgz", + "integrity": "sha1-cj599ugBrFYTETp+RFqbactjKBg=", + "dev": true, + "requires": { + "delayed-stream": "1.0.0" + } + }, + "commander": { + "version": "2.16.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.16.0.tgz", + "integrity": "sha512-sVXqklSaotK9at437sFlFpyOcJonxe0yST/AG9DkQKUdIE6IqGIMv4SfAQSKaJbSdVEJYItASCrBiVQHq1HQew==", + "dev": true, + "optional": true + }, + "component-bind": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/component-bind/-/component-bind-1.0.0.tgz", + "integrity": "sha1-AMYIq33Nk4l8AAllGx06jh5zu9E=", + "dev": true + }, + "component-emitter": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz", + "integrity": "sha1-E3kY1teCg/ffemt8WmPhQOaUJeY=", + "dev": true + }, + "component-inherit": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/component-inherit/-/component-inherit-0.0.3.tgz", + "integrity": "sha1-ZF/ErfWLcrZJ1crmUTVhnbJv8UM=", + "dev": true + }, + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "connect": { + "version": "3.6.6", + "resolved": "https://registry.npmjs.org/connect/-/connect-3.6.6.tgz", + "integrity": "sha1-Ce/2xVr3I24TcTWnJXSFi2eG9SQ=", + "dev": true, + "requires": { + "debug": "2.6.9", + "finalhandler": "1.1.0", + "parseurl": "1.3.2", + "utils-merge": "1.0.1" + } + }, + "content-type": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", + "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==", + "dev": true + }, + "cookie": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.3.1.tgz", + "integrity": "sha1-5+Ch+e9DtMi6klxcWpboBtFoc7s=", + "dev": true + }, + "copy-descriptor": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/copy-descriptor/-/copy-descriptor-0.1.1.tgz", + "integrity": "sha1-Z29us8OZl8LuGsOpJP1hJHSPV40=", + "dev": true + }, + "core-js": { + "version": "2.5.7", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.5.7.tgz", + "integrity": "sha512-RszJCAxg/PP6uzXVXL6BsxSXx/B05oJAQ2vkJRjyjrEcNVycaqOmNb5OTxZPE3xa5gwZduqza6L9JOCenh/Ecw==", + "dev": true + }, + "core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", + "dev": true + }, + "cryptiles": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/cryptiles/-/cryptiles-2.0.5.tgz", + "integrity": "sha1-O9/s3GCBR8HGcgL6KR59ylnqo7g=", + "dev": true, + "optional": true, + "requires": { + "boom": "2.10.1" + } + }, + "custom-event": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/custom-event/-/custom-event-1.0.1.tgz", + "integrity": "sha1-XQKkaFCt8bSjF5RqOSj8y1v9BCU=", + "dev": true + }, + "dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", + "dev": true, + "optional": true, + "requires": { + "assert-plus": "1.0.0" + } + }, + "data-uri-to-buffer": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-1.2.0.tgz", + "integrity": "sha512-vKQ9DTQPN1FLYiiEEOQ6IBGFqvjCa5rSK3cWMy/Nespm5d/x3dGFT9UBZnkLxCwua/IXBi2TYnwTEpsOvhC4UQ==", + "dev": true, + "optional": true + }, + "date-format": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/date-format/-/date-format-1.2.0.tgz", + "integrity": "sha1-YV6CjiM90aubua4JUODOzPpuytg=", + "dev": true + }, + "debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + }, + "decode-uri-component": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz", + "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=", + "dev": true + }, + "deep-is": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz", + "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", + "dev": true, + "optional": true + }, + "define-property": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-2.0.2.tgz", + "integrity": "sha512-jwK2UV4cnPpbcG7+VRARKTZPUWowwXA8bzH5NP6ud0oeAxyYPuGZUAC7hMugpCdz4BeSZl2Dl9k66CHJ/46ZYQ==", + "dev": true, + "requires": { + "is-descriptor": "1.0.2", + "isobject": "3.0.1" + }, + "dependencies": { + "is-accessor-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", + "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-data-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", + "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-descriptor": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", + "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", + "dev": true, + "requires": { + "is-accessor-descriptor": "1.0.0", + "is-data-descriptor": "1.0.0", + "kind-of": "6.0.2" + } + } + } + }, + "degenerator": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/degenerator/-/degenerator-1.0.4.tgz", + "integrity": "sha1-/PSQo37OJmRk2cxDGrmMWBnO0JU=", + "dev": true, + "optional": true, + "requires": { + "ast-types": "0.11.5", + "escodegen": "1.11.0", + "esprima": "3.1.3" + } + }, + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", + "dev": true + }, + "depd": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", + "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=", + "dev": true + }, + "di": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/di/-/di-0.0.1.tgz", + "integrity": "sha1-gGZJMmzqp8qjMG112YXqJ0i6kTw=", + "dev": true + }, + "dom-serialize": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/dom-serialize/-/dom-serialize-2.2.1.tgz", + "integrity": "sha1-ViromZ9Evl6jB29UGdzVnrQ6yVs=", + "dev": true, + "requires": { + "custom-event": "1.0.1", + "ent": "2.2.0", + "extend": "3.0.2", + "void-elements": "2.0.1" + } + }, + "double-ended-queue": { + "version": "2.1.0-0", + "resolved": "https://registry.npmjs.org/double-ended-queue/-/double-ended-queue-2.1.0-0.tgz", + "integrity": "sha1-ED01J/0xUo9AGIEwyEHv3XgmTlw=", + "dev": true, + "optional": true + }, + "ecc-jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.1.tgz", + "integrity": "sha1-D8c6ntXw1Tw4GTOYUj735UN3dQU=", + "dev": true, + "optional": true, + "requires": { + "jsbn": "0.1.1" + } + }, + "ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=", + "dev": true + }, + "encodeurl": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", + "integrity": "sha1-rT/0yG7C0CkyL1oCw6mmBslbP1k=", + "dev": true + }, + "engine.io": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-3.1.5.tgz", + "integrity": "sha512-D06ivJkYxyRrcEe0bTpNnBQNgP9d3xog+qZlLbui8EsMr/DouQpf5o9FzJnWYHEYE0YsFHllUv2R1dkgYZXHcA==", + "dev": true, + "requires": { + "accepts": "1.3.5", + "base64id": "1.0.0", + "cookie": "0.3.1", + "debug": "3.1.0", + "engine.io-parser": "2.1.2", + "uws": "9.14.0", + "ws": "3.3.3" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "engine.io-client": { + "version": "3.1.6", + "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-3.1.6.tgz", + "integrity": "sha512-hnuHsFluXnsKOndS4Hv6SvUrgdYx1pk2NqfaDMW+GWdgfU3+/V25Cj7I8a0x92idSpa5PIhJRKxPvp9mnoLsfg==", + "dev": true, + "requires": { + "component-emitter": "1.2.1", + "component-inherit": "0.0.3", + "debug": "3.1.0", + "engine.io-parser": "2.1.2", + "has-cors": "1.1.0", + "indexof": "0.0.1", + "parseqs": "0.0.5", + "parseuri": "0.0.5", + "ws": "3.3.3", + "xmlhttprequest-ssl": "1.5.5", + "yeast": "0.1.2" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "engine.io-parser": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-2.1.2.tgz", + "integrity": "sha512-dInLFzr80RijZ1rGpx1+56/uFoH7/7InhH3kZt+Ms6hT8tNx3NGW/WNSA/f8As1WkOfkuyb3tnRyuXGxusclMw==", + "dev": true, + "requires": { + "after": "0.8.2", + "arraybuffer.slice": "0.0.7", + "base64-arraybuffer": "0.1.5", + "blob": "0.0.4", + "has-binary2": "1.0.3" + } + }, + "ent": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/ent/-/ent-2.2.0.tgz", + "integrity": "sha1-6WQhkyWiHQX0RGai9obtbOX13R0=", + "dev": true + }, + "es6-promise": { + "version": "4.2.4", + "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.4.tgz", + "integrity": "sha512-/NdNZVJg+uZgtm9eS3O6lrOLYmQag2DjdEXuPaHlZ6RuVqgqaVZfgYCepEIKsLqwdQArOPtC3XzRLqGGfT8KQQ==", + "dev": true + }, + "es6-promisify": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/es6-promisify/-/es6-promisify-5.0.0.tgz", + "integrity": "sha1-UQnWLz5W6pZ8S2NQWu8IKRyKUgM=", + "dev": true, + "requires": { + "es6-promise": "4.2.4" + } + }, + "escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=", + "dev": true + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true, + "optional": true + }, + "escodegen": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.11.0.tgz", + "integrity": "sha512-IeMV45ReixHS53K/OmfKAIztN/igDHzTJUhZM3k1jMhIZWjk45SMwAtBsEXiJp3vSPmTcu6CXn7mDvFHRN66fw==", + "dev": true, + "optional": true, + "requires": { + "esprima": "3.1.3", + "estraverse": "4.2.0", + "esutils": "2.0.2", + "optionator": "0.8.2", + "source-map": "0.6.1" + } + }, + "esprima": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-3.1.3.tgz", + "integrity": "sha1-/cpRzuYTOJXjyI1TXOSdv/YqRjM=", + "dev": true + }, + "estraverse": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.2.0.tgz", + "integrity": "sha1-De4/7TH81GlhjOc0IJn8GvoL2xM=", + "dev": true, + "optional": true + }, + "esutils": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.2.tgz", + "integrity": "sha1-Cr9PHKpbyx96nYrMbepPqqBLrJs=", + "dev": true, + "optional": true + }, + "eventemitter3": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-3.1.0.tgz", + "integrity": "sha512-ivIvhpq/Y0uSjcHDcOIccjmYjGLcP09MFGE7ysAwkAvkXfpZlC985pH2/ui64DKazbTW/4kN3yqozUxlXzI6cA==", + "dev": true + }, + "expand-braces": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/expand-braces/-/expand-braces-0.1.2.tgz", + "integrity": "sha1-SIsdHSRRyz06axks/AMPRMWFX+o=", + "dev": true, + "requires": { + "array-slice": "0.2.3", + "array-unique": "0.2.1", + "braces": "0.1.5" + }, + "dependencies": { + "array-unique": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.2.1.tgz", + "integrity": "sha1-odl8yvy8JiXMcPrc6zalDFiwGlM=", + "dev": true + }, + "braces": { + "version": "0.1.5", + "resolved": "https://registry.npmjs.org/braces/-/braces-0.1.5.tgz", + "integrity": "sha1-wIVxEIUpHYt1/ddOqw+FlygHEeY=", + "dev": true, + "requires": { + "expand-range": "0.1.1" + } + } + } + }, + "expand-brackets": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz", + "integrity": "sha1-t3c14xXOMPa27/D4OwQVGiJEliI=", + "dev": true, + "requires": { + "debug": "2.6.9", + "define-property": "0.2.5", + "extend-shallow": "2.0.1", + "posix-character-classes": "0.1.1", + "regex-not": "1.0.2", + "snapdragon": "0.8.2", + "to-regex": "3.0.2" + }, + "dependencies": { + "define-property": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", + "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", + "dev": true, + "requires": { + "is-descriptor": "0.1.6" + } + }, + "extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "dev": true, + "requires": { + "is-extendable": "0.1.1" + } + } + } + }, + "expand-range": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/expand-range/-/expand-range-0.1.1.tgz", + "integrity": "sha1-TLjtoJk8pW+k9B/ELzy7TMrf8EQ=", + "dev": true, + "requires": { + "is-number": "0.1.1", + "repeat-string": "0.2.2" + }, + "dependencies": { + "is-number": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-0.1.1.tgz", + "integrity": "sha1-aaevEWlj1HIG7JvZtIoUIW8eOAY=", + "dev": true + }, + "repeat-string": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-0.2.2.tgz", + "integrity": "sha1-x6jTI2BoNiBZp+RlH8aITosftK4=", + "dev": true + } + } + }, + "extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "dev": true + }, + "extend-shallow": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-3.0.2.tgz", + "integrity": "sha1-Jqcarwc7OfshJxcnRhMcJwQCjbg=", + "dev": true, + "requires": { + "assign-symbols": "1.0.0", + "is-extendable": "1.0.1" + }, + "dependencies": { + "is-extendable": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz", + "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", + "dev": true, + "requires": { + "is-plain-object": "2.0.4" + } + } + } + }, + "extglob": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/extglob/-/extglob-2.0.4.tgz", + "integrity": "sha512-Nmb6QXkELsuBr24CJSkilo6UHHgbekK5UiZgfE6UHD3Eb27YC6oD+bhcT+tJ6cl8dmsgdQxnWlcry8ksBIBLpw==", + "dev": true, + "requires": { + "array-unique": "0.3.2", + "define-property": "1.0.0", + "expand-brackets": "2.1.4", + "extend-shallow": "2.0.1", + "fragment-cache": "0.2.1", + "regex-not": "1.0.2", + "snapdragon": "0.8.2", + "to-regex": "3.0.2" + }, + "dependencies": { + "define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", + "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", + "dev": true, + "requires": { + "is-descriptor": "1.0.2" + } + }, + "extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "dev": true, + "requires": { + "is-extendable": "0.1.1" + } + }, + "is-accessor-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", + "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-data-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", + "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-descriptor": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", + "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", + "dev": true, + "requires": { + "is-accessor-descriptor": "1.0.0", + "is-data-descriptor": "1.0.0", + "kind-of": "6.0.2" + } + } + } + }, + "extsprintf": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", + "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=", + "dev": true + }, + "fast-deep-equal": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-1.1.0.tgz", + "integrity": "sha1-wFNHeBfIa1HaqFPIHgWbcz0CNhQ=", + "dev": true, + "optional": true + }, + "fast-json-stable-stringify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", + "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=", + "dev": true, + "optional": true + }, + "fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", + "dev": true, + "optional": true + }, + "file-uri-to-path": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", + "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", + "dev": true, + "optional": true + }, + "fill-range": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-4.0.0.tgz", + "integrity": "sha1-1USBHUKPmOsGpj3EAtJAPDKMOPc=", + "dev": true, + "requires": { + "extend-shallow": "2.0.1", + "is-number": "3.0.0", + "repeat-string": "1.6.1", + "to-regex-range": "2.1.1" + }, + "dependencies": { + "extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "dev": true, + "requires": { + "is-extendable": "0.1.1" + } + } + } + }, + "finalhandler": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.0.tgz", + "integrity": "sha1-zgtoVbRYU+eRsvzGgARtiCU91/U=", + "dev": true, + "requires": { + "debug": "2.6.9", + "encodeurl": "1.0.2", + "escape-html": "1.0.3", + "on-finished": "2.3.0", + "parseurl": "1.3.2", + "statuses": "1.3.1", + "unpipe": "1.0.0" + }, + "dependencies": { + "statuses": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.3.1.tgz", + "integrity": "sha1-+vUbnrdKrvOzrPStX2Gr8ky3uT4=", + "dev": true + } + } + }, + "follow-redirects": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.1.tgz", + "integrity": "sha512-v9GI1hpaqq1ZZR6pBD1+kI7O24PhDvNGNodjS3MdcEqyrahCp8zbtpv+2B/krUnSmUH80lbAS7MrdeK5IylgKg==", + "dev": true, + "requires": { + "debug": "3.1.0" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "for-in": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz", + "integrity": "sha1-gQaNKVqBQuwKxybG4iAMMPttXoA=", + "dev": true + }, + "forever-agent": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", + "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=", + "dev": true, + "optional": true + }, + "form-data": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.2.tgz", + "integrity": "sha1-SXBJi+YEwgwAXU9cI67NIda0kJk=", + "dev": true, + "optional": true, + "requires": { + "asynckit": "0.4.0", + "combined-stream": "1.0.6", + "mime-types": "2.1.19" + } + }, + "fragment-cache": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/fragment-cache/-/fragment-cache-0.2.1.tgz", + "integrity": "sha1-QpD60n8T6Jvn8zeZxrxaCr//DRk=", + "dev": true, + "requires": { + "map-cache": "0.2.2" + } + }, + "fs-access": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/fs-access/-/fs-access-1.0.1.tgz", + "integrity": "sha1-1qh/JiJxzv6+wwxVNAf7mV2od3o=", + "dev": true, + "requires": { + "null-check": "1.0.0" + } + }, + "fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "fsevents": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-1.2.4.tgz", + "integrity": "sha512-z8H8/diyk76B7q5wg+Ud0+CqzcAF3mBBI/bA5ne5zrRUUIvNkJY//D3BqyH571KuAC4Nr7Rw7CjWX4r0y9DvNg==", + "dev": true, + "optional": true, + "requires": { + "nan": "2.10.0", + "node-pre-gyp": "0.10.0" + }, + "dependencies": { + "abbrev": { + "version": "1.1.1", + "bundled": true, + "dev": true, + "optional": true + }, + "ansi-regex": { + "version": "2.1.1", + "bundled": true, + "dev": true + }, + "aproba": { + "version": "1.2.0", + "bundled": true, + "dev": true, + "optional": true + }, + "are-we-there-yet": { + "version": "1.1.4", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "delegates": "1.0.0", + "readable-stream": "2.3.6" + } + }, + "balanced-match": { + "version": "1.0.0", + "bundled": true, + "dev": true + }, + "brace-expansion": { + "version": "1.1.11", + "bundled": true, + "dev": true, + "requires": { + "balanced-match": "1.0.0", + "concat-map": "0.0.1" + } + }, + "chownr": { + "version": "1.0.1", + "bundled": true, + "dev": true, + "optional": true + }, + "code-point-at": { + "version": "1.1.0", + "bundled": true, + "dev": true + }, + "concat-map": { + "version": "0.0.1", + "bundled": true, + "dev": true + }, + "console-control-strings": { + "version": "1.1.0", + "bundled": true, + "dev": true + }, + "core-util-is": { + "version": "1.0.2", + "bundled": true, + "dev": true, + "optional": true + }, + "debug": { + "version": "2.6.9", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "ms": "2.0.0" + } + }, + "deep-extend": { + "version": "0.5.1", + "bundled": true, + "dev": true, + "optional": true + }, + "delegates": { + "version": "1.0.0", + "bundled": true, + "dev": true, + "optional": true + }, + "detect-libc": { + "version": "1.0.3", + "bundled": true, + "dev": true, + "optional": true + }, + "fs-minipass": { + "version": "1.2.5", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "minipass": "2.2.4" + } + }, + "fs.realpath": { + "version": "1.0.0", + "bundled": true, + "dev": true, + "optional": true + }, + "gauge": { + "version": "2.7.4", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "aproba": "1.2.0", + "console-control-strings": "1.1.0", + "has-unicode": "2.0.1", + "object-assign": "4.1.1", + "signal-exit": "3.0.2", + "string-width": "1.0.2", + "strip-ansi": "3.0.1", + "wide-align": "1.1.2" + } + }, + "glob": { + "version": "7.1.2", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "fs.realpath": "1.0.0", + "inflight": "1.0.6", + "inherits": "2.0.3", + "minimatch": "3.0.4", + "once": "1.4.0", + "path-is-absolute": "1.0.1" + } + }, + "has-unicode": { + "version": "2.0.1", + "bundled": true, + "dev": true, + "optional": true + }, + "iconv-lite": { + "version": "0.4.21", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "safer-buffer": "2.1.2" + } + }, + "ignore-walk": { + "version": "3.0.1", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "minimatch": "3.0.4" + } + }, + "inflight": { + "version": "1.0.6", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "once": "1.4.0", + "wrappy": "1.0.2" + } + }, + "inherits": { + "version": "2.0.3", + "bundled": true, + "dev": true + }, + "ini": { + "version": "1.3.5", + "bundled": true, + "dev": true, + "optional": true + }, + "is-fullwidth-code-point": { + "version": "1.0.0", + "bundled": true, + "dev": true, + "requires": { + "number-is-nan": "1.0.1" + } + }, + "isarray": { + "version": "1.0.0", + "bundled": true, + "dev": true, + "optional": true + }, + "minimatch": { + "version": "3.0.4", + "bundled": true, + "dev": true, + "requires": { + "brace-expansion": "1.1.11" + } + }, + "minimist": { + "version": "0.0.8", + "bundled": true, + "dev": true + }, + "minipass": { + "version": "2.2.4", + "bundled": true, + "dev": true, + "requires": { + "safe-buffer": "5.1.1", + "yallist": "3.0.2" + } + }, + "minizlib": { + "version": "1.1.0", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "minipass": "2.2.4" + } + }, + "mkdirp": { + "version": "0.5.1", + "bundled": true, + "dev": true, + "requires": { + "minimist": "0.0.8" + } + }, + "ms": { + "version": "2.0.0", + "bundled": true, + "dev": true, + "optional": true + }, + "needle": { + "version": "2.2.0", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "debug": "2.6.9", + "iconv-lite": "0.4.21", + "sax": "1.2.4" + } + }, + "node-pre-gyp": { + "version": "0.10.0", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "detect-libc": "1.0.3", + "mkdirp": "0.5.1", + "needle": "2.2.0", + "nopt": "4.0.1", + "npm-packlist": "1.1.10", + "npmlog": "4.1.2", + "rc": "1.2.7", + "rimraf": "2.6.2", + "semver": "5.5.0", + "tar": "4.4.1" + } + }, + "nopt": { + "version": "4.0.1", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "abbrev": "1.1.1", + "osenv": "0.1.5" + } + }, + "npm-bundled": { + "version": "1.0.3", + "bundled": true, + "dev": true, + "optional": true + }, + "npm-packlist": { + "version": "1.1.10", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "ignore-walk": "3.0.1", + "npm-bundled": "1.0.3" + } + }, + "npmlog": { + "version": "4.1.2", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "are-we-there-yet": "1.1.4", + "console-control-strings": "1.1.0", + "gauge": "2.7.4", + "set-blocking": "2.0.0" + } + }, + "number-is-nan": { + "version": "1.0.1", + "bundled": true, + "dev": true + }, + "object-assign": { + "version": "4.1.1", + "bundled": true, + "dev": true, + "optional": true + }, + "once": { + "version": "1.4.0", + "bundled": true, + "dev": true, + "requires": { + "wrappy": "1.0.2" + } + }, + "os-homedir": { + "version": "1.0.2", + "bundled": true, + "dev": true, + "optional": true + }, + "os-tmpdir": { + "version": "1.0.2", + "bundled": true, + "dev": true, + "optional": true + }, + "osenv": { + "version": "0.1.5", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "os-homedir": "1.0.2", + "os-tmpdir": "1.0.2" + } + }, + "path-is-absolute": { + "version": "1.0.1", + "bundled": true, + "dev": true, + "optional": true + }, + "process-nextick-args": { + "version": "2.0.0", + "bundled": true, + "dev": true, + "optional": true + }, + "rc": { + "version": "1.2.7", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "deep-extend": "0.5.1", + "ini": "1.3.5", + "minimist": "1.2.0", + "strip-json-comments": "2.0.1" + }, + "dependencies": { + "minimist": { + "version": "1.2.0", + "bundled": true, + "dev": true, + "optional": true + } + } + }, + "readable-stream": { + "version": "2.3.6", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "core-util-is": "1.0.2", + "inherits": "2.0.3", + "isarray": "1.0.0", + "process-nextick-args": "2.0.0", + "safe-buffer": "5.1.1", + "string_decoder": "1.1.1", + "util-deprecate": "1.0.2" + } + }, + "rimraf": { + "version": "2.6.2", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "glob": "7.1.2" + } + }, + "safe-buffer": { + "version": "5.1.1", + "bundled": true, + "dev": true + }, + "safer-buffer": { + "version": "2.1.2", + "bundled": true, + "dev": true, + "optional": true + }, + "sax": { + "version": "1.2.4", + "bundled": true, + "dev": true, + "optional": true + }, + "semver": { + "version": "5.5.0", + "bundled": true, + "dev": true, + "optional": true + }, + "set-blocking": { + "version": "2.0.0", + "bundled": true, + "dev": true, + "optional": true + }, + "signal-exit": { + "version": "3.0.2", + "bundled": true, + "dev": true, + "optional": true + }, + "string-width": { + "version": "1.0.2", + "bundled": true, + "dev": true, + "requires": { + "code-point-at": "1.1.0", + "is-fullwidth-code-point": "1.0.0", + "strip-ansi": "3.0.1" + } + }, + "string_decoder": { + "version": "1.1.1", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "safe-buffer": "5.1.1" + } + }, + "strip-ansi": { + "version": "3.0.1", + "bundled": true, + "dev": true, + "requires": { + "ansi-regex": "2.1.1" + } + }, + "strip-json-comments": { + "version": "2.0.1", + "bundled": true, + "dev": true, + "optional": true + }, + "tar": { + "version": "4.4.1", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "chownr": "1.0.1", + "fs-minipass": "1.2.5", + "minipass": "2.2.4", + "minizlib": "1.1.0", + "mkdirp": "0.5.1", + "safe-buffer": "5.1.1", + "yallist": "3.0.2" + } + }, + "util-deprecate": { + "version": "1.0.2", + "bundled": true, + "dev": true, + "optional": true + }, + "wide-align": { + "version": "1.1.2", + "bundled": true, + "dev": true, + "optional": true, + "requires": { + "string-width": "1.0.2" + } + }, + "wrappy": { + "version": "1.0.2", + "bundled": true, + "dev": true + }, + "yallist": { + "version": "3.0.2", + "bundled": true, + "dev": true + } + } + }, + "ftp": { + "version": "0.3.10", + "resolved": "https://registry.npmjs.org/ftp/-/ftp-0.3.10.tgz", + "integrity": "sha1-kZfYYa2BQvPmPVqDv+TFn3MwiF0=", + "dev": true, + "optional": true, + "requires": { + "readable-stream": "1.1.14", + "xregexp": "2.0.0" + }, + "dependencies": { + "isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", + "dev": true, + "optional": true + }, + "readable-stream": { + "version": "1.1.14", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", + "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", + "dev": true, + "optional": true, + "requires": { + "core-util-is": "1.0.2", + "inherits": "2.0.3", + "isarray": "0.0.1", + "string_decoder": "0.10.31" + } + }, + "string_decoder": { + "version": "0.10.31", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", + "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", + "dev": true, + "optional": true + } + } + }, + "generate-function": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", + "integrity": "sha1-aFj+fAlpt9TpCTM3ZHrHn2DfvnQ=", + "dev": true, + "optional": true + }, + "generate-object-property": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/generate-object-property/-/generate-object-property-1.2.0.tgz", + "integrity": "sha1-nA4cQDCM6AT0eDYYuTf6iPmdUNA=", + "dev": true, + "optional": true, + "requires": { + "is-property": "1.0.2" + } + }, + "get-uri": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-2.0.2.tgz", + "integrity": "sha512-ZD325dMZOgerGqF/rF6vZXyFGTAay62svjQIT+X/oU2PtxYpFxvSkbsdi+oxIrsNxlZVd4y8wUDqkaExWTI/Cw==", + "dev": true, + "optional": true, + "requires": { + "data-uri-to-buffer": "1.2.0", + "debug": "2.6.9", + "extend": "3.0.2", + "file-uri-to-path": "1.0.0", + "ftp": "0.3.10", + "readable-stream": "2.3.6" + } + }, + "get-value": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", + "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=", + "dev": true + }, + "getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", + "dev": true, + "optional": true, + "requires": { + "assert-plus": "1.0.0" + } + }, + "glob": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz", + "integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==", + "dev": true, + "requires": { + "fs.realpath": "1.0.0", + "inflight": "1.0.6", + "inherits": "2.0.3", + "minimatch": "3.0.4", + "once": "1.4.0", + "path-is-absolute": "1.0.1" + } + }, + "glob-parent": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-3.1.0.tgz", + "integrity": "sha1-nmr2KZ2NO9K9QEMIMr0RPfkGxa4=", + "dev": true, + "requires": { + "is-glob": "3.1.0", + "path-dirname": "1.0.2" + }, + "dependencies": { + "is-glob": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-3.1.0.tgz", + "integrity": "sha1-e6WuJCF4BKxwcHuWkiVnSGzD6Eo=", + "dev": true, + "requires": { + "is-extglob": "2.1.1" + } + } + } + }, + "graceful-fs": { + "version": "4.1.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.1.11.tgz", + "integrity": "sha1-Dovf5NHduIVNZOBOp8AOKgJuVlg=", + "dev": true + }, + "har-schema": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", + "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=", + "dev": true, + "optional": true + }, + "har-validator": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.0.3.tgz", + "integrity": "sha1-ukAsJmGU8VlW7xXg/PJCmT9qff0=", + "dev": true, + "optional": true, + "requires": { + "ajv": "5.5.2", + "har-schema": "2.0.0" + } + }, + "has-ansi": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/has-ansi/-/has-ansi-2.0.0.tgz", + "integrity": "sha1-NPUEnOHs3ysGSa8+8k5F7TVBbZE=", + "dev": true, + "optional": true, + "requires": { + "ansi-regex": "2.1.1" + } + }, + "has-binary2": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-binary2/-/has-binary2-1.0.3.tgz", + "integrity": "sha512-G1LWKhDSvhGeAQ8mPVQlqNcOB2sJdwATtZKl2pDKKHfpf/rYj24lkinxf69blJbnsvtqqNU+L3SL50vzZhXOnw==", + "dev": true, + "requires": { + "isarray": "2.0.1" + }, + "dependencies": { + "isarray": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.1.tgz", + "integrity": "sha1-o32U7ZzaLVmGXJ92/llu4fM4dB4=", + "dev": true + } + } + }, + "has-cors": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-cors/-/has-cors-1.1.0.tgz", + "integrity": "sha1-XkdHk/fqmEPRu5nCPu9J/xJv/zk=", + "dev": true + }, + "has-value": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-value/-/has-value-1.0.0.tgz", + "integrity": "sha1-GLKB2lhbHFxR3vJMkw7SmgvmsXc=", + "dev": true, + "requires": { + "get-value": "2.0.6", + "has-values": "1.0.0", + "isobject": "3.0.1" + } + }, + "has-values": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-values/-/has-values-1.0.0.tgz", + "integrity": "sha1-lbC2P+whRmGab+V/51Yo1aOe/k8=", + "dev": true, + "requires": { + "is-number": "3.0.0", + "kind-of": "4.0.0" + }, + "dependencies": { + "kind-of": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-4.0.0.tgz", + "integrity": "sha1-IIE989cSkosgc3hpGkUGb65y3Vc=", + "dev": true, + "requires": { + "is-buffer": "1.1.6" + } + } + } + }, + "hawk": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/hawk/-/hawk-3.1.3.tgz", + "integrity": "sha1-B4REvXwWQLD+VA0sm3PVlnjo4cQ=", + "dev": true, + "optional": true, + "requires": { + "boom": "2.10.1", + "cryptiles": "2.0.5", + "hoek": "2.16.3", + "sntp": "1.0.9" + } + }, + "hipchat-notifier": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/hipchat-notifier/-/hipchat-notifier-1.1.0.tgz", + "integrity": "sha1-ttJJdVQ3wZEII2d5nTupoPI7Ix4=", + "dev": true, + "optional": true, + "requires": { + "lodash": "4.17.10", + "request": "2.87.0" + } + }, + "hoek": { + "version": "2.16.3", + "resolved": "https://registry.npmjs.org/hoek/-/hoek-2.16.3.tgz", + "integrity": "sha1-ILt0A9POo5jpHcRxCo/xuCdKJe0=", + "dev": true + }, + "http-errors": { + "version": "1.6.3", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz", + "integrity": "sha1-i1VoC7S+KDoLW/TqLjhYC+HZMg0=", + "dev": true, + "requires": { + "depd": "1.1.2", + "inherits": "2.0.3", + "setprototypeof": "1.1.0", + "statuses": "1.5.0" + } + }, + "http-proxy": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.17.0.tgz", + "integrity": "sha512-Taqn+3nNvYRfJ3bGvKfBSRwy1v6eePlm3oc/aWVxZp57DQr5Eq3xhKJi7Z4hZpS8PC3H4qI+Yly5EmFacGuA/g==", + "dev": true, + "requires": { + "eventemitter3": "3.1.0", + "follow-redirects": "1.5.1", + "requires-port": "1.0.0" + } + }, + "http-proxy-agent": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-2.1.0.tgz", + "integrity": "sha512-qwHbBLV7WviBl0rQsOzH6o5lwyOIvwp/BdFnvVxXORldu5TmjFfjzBcWUWS5kWAZhmv+JtiDhSuQCp4sBfbIgg==", + "dev": true, + "requires": { + "agent-base": "4.2.1", + "debug": "3.1.0" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "http-signature": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", + "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", + "dev": true, + "optional": true, + "requires": { + "assert-plus": "1.0.0", + "jsprim": "1.4.1", + "sshpk": "1.14.2" + } + }, + "httpntlm": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/httpntlm/-/httpntlm-1.6.1.tgz", + "integrity": "sha1-rQFScUOi6Hc8+uapb1hla7UqNLI=", + "dev": true, + "requires": { + "httpreq": "0.4.24", + "underscore": "1.7.0" + } + }, + "httpreq": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/httpreq/-/httpreq-0.4.24.tgz", + "integrity": "sha1-QzX/2CzZaWaKOUZckprGHWOTYn8=", + "dev": true + }, + "https-proxy-agent": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-2.2.1.tgz", + "integrity": "sha512-HPCTS1LW51bcyMYbxUIOO4HEOlQ1/1qRaFWcyxvwaqUS9TY88aoEuHUY33kuAh1YhVVaDQhLZsnPd+XNARWZlQ==", + "dev": true, + "requires": { + "agent-base": "4.2.1", + "debug": "3.1.0" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "iconv-lite": { + "version": "0.4.23", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.23.tgz", + "integrity": "sha512-neyTUVFtahjf0mB3dZT77u+8O0QB89jFdnBkd5P1JgYPbPaia3gXXOVL2fq8VyU2gMMD7SaN7QukTB/pmXYvDA==", + "dev": true, + "requires": { + "safer-buffer": "2.1.2" + } + }, + "indexof": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/indexof/-/indexof-0.0.1.tgz", + "integrity": "sha1-gtwzbSMrkGIXnQWrMpOmYFn9Q10=", + "dev": true + }, + "inflection": { + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/inflection/-/inflection-1.12.0.tgz", + "integrity": "sha1-ogCTVlbW9fa8TcdQLhrstwMihBY=", + "dev": true, + "optional": true + }, + "inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "requires": { + "once": "1.4.0", + "wrappy": "1.0.2" + } + }, + "inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", + "dev": true + }, + "ip": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/ip/-/ip-1.1.5.tgz", + "integrity": "sha1-vd7XARQpCCjAoDnnLvJfWq7ENUo=", + "dev": true + }, + "is-accessor-descriptor": { + "version": "0.1.6", + "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-0.1.6.tgz", + "integrity": "sha1-qeEss66Nh2cn7u84Q/igiXtcmNY=", + "dev": true, + "requires": { + "kind-of": "3.2.2" + }, + "dependencies": { + "kind-of": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", + "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", + "dev": true, + "requires": { + "is-buffer": "1.1.6" + } + } + } + }, + "is-binary-path": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-1.0.1.tgz", + "integrity": "sha1-dfFmQrSA8YenEcgUFh/TpKdlWJg=", + "dev": true, + "requires": { + "binary-extensions": "1.11.0" + } + }, + "is-buffer": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", + "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", + "dev": true + }, + "is-data-descriptor": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-0.1.4.tgz", + "integrity": "sha1-C17mSDiOLIYCgueT8YVv7D8wG1Y=", + "dev": true, + "requires": { + "kind-of": "3.2.2" + }, + "dependencies": { + "kind-of": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", + "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", + "dev": true, + "requires": { + "is-buffer": "1.1.6" + } + } + } + }, + "is-descriptor": { + "version": "0.1.6", + "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.6.tgz", + "integrity": "sha512-avDYr0SB3DwO9zsMov0gKCESFYqCnE4hq/4z3TdUlukEy5t9C0YRq7HLrsN52NAcqXKaepeCD0n+B0arnVG3Hg==", + "dev": true, + "requires": { + "is-accessor-descriptor": "0.1.6", + "is-data-descriptor": "0.1.4", + "kind-of": "5.1.0" + }, + "dependencies": { + "kind-of": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-5.1.0.tgz", + "integrity": "sha512-NGEErnH6F2vUuXDh+OlbcKW7/wOcfdRHaZ7VWtqCztfHri/++YKmP51OdWeGPuqCOba6kk2OTe5d02VmTB80Pw==", + "dev": true + } + } + }, + "is-extendable": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", + "integrity": "sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik=", + "dev": true + }, + "is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true + }, + "is-glob": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.0.tgz", + "integrity": "sha1-lSHHaEXMJhCoUgPd8ICpWML/q8A=", + "dev": true, + "requires": { + "is-extglob": "2.1.1" + } + }, + "is-my-ip-valid": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-my-ip-valid/-/is-my-ip-valid-1.0.0.tgz", + "integrity": "sha512-gmh/eWXROncUzRnIa1Ubrt5b8ep/MGSnfAUI3aRp+sqTCs1tv1Isl8d8F6JmkN3dXKc3ehZMrtiPN9eL03NuaQ==", + "dev": true, + "optional": true + }, + "is-my-json-valid": { + "version": "2.17.2", + "resolved": "https://registry.npmjs.org/is-my-json-valid/-/is-my-json-valid-2.17.2.tgz", + "integrity": "sha512-IBhBslgngMQN8DDSppmgDv7RNrlFotuuDsKcrCP3+HbFaVivIBU7u9oiiErw8sH4ynx3+gOGQ3q2otkgiSi6kg==", + "dev": true, + "optional": true, + "requires": { + "generate-function": "2.0.0", + "generate-object-property": "1.2.0", + "is-my-ip-valid": "1.0.0", + "jsonpointer": "4.0.1", + "xtend": "4.0.1" + } + }, + "is-number": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz", + "integrity": "sha1-JP1iAaR4LPUFYcgQJ2r8fRLXEZU=", + "dev": true, + "requires": { + "kind-of": "3.2.2" + }, + "dependencies": { + "kind-of": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", + "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", + "dev": true, + "requires": { + "is-buffer": "1.1.6" + } + } + } + }, + "is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "dev": true, + "requires": { + "isobject": "3.0.1" + } + }, + "is-property": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-property/-/is-property-1.0.2.tgz", + "integrity": "sha1-V/4cTkhHTt1lsJkR8msc1Ald2oQ=", + "dev": true, + "optional": true + }, + "is-stream": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", + "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", + "dev": true, + "optional": true + }, + "is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=", + "dev": true, + "optional": true + }, + "is-windows": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", + "integrity": "sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==", + "dev": true + }, + "isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", + "dev": true + }, + "isbinaryfile": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/isbinaryfile/-/isbinaryfile-3.0.2.tgz", + "integrity": "sha1-Sj6XTsDLqQBNP8bN5yCeppNopiE=", + "dev": true + }, + "isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", + "dev": true + }, + "isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", + "dev": true + }, + "isstream": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", + "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=", + "dev": true, + "optional": true + }, + "jasmine-core": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jasmine-core/-/jasmine-core-3.1.0.tgz", + "integrity": "sha1-pHheE11d9lAk38kiSVPfWFvSdmw=", + "dev": true + }, + "jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", + "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=", + "dev": true, + "optional": true + }, + "json-schema": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", + "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=", + "dev": true, + "optional": true + }, + "json-schema-traverse": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.3.1.tgz", + "integrity": "sha1-NJptRMU6Ud6JtAgFxdXlm0F9M0A=", + "dev": true, + "optional": true + }, + "json-stringify-safe": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", + "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=", + "dev": true + }, + "jsonpointer": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-4.0.1.tgz", + "integrity": "sha1-T9kss04OnbPInIYi7PUfm5eMbLk=", + "dev": true, + "optional": true + }, + "jsprim": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", + "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", + "dev": true, + "optional": true, + "requires": { + "assert-plus": "1.0.0", + "extsprintf": "1.3.0", + "json-schema": "0.2.3", + "verror": "1.10.0" + } + }, + "karma": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/karma/-/karma-2.0.4.tgz", + "integrity": "sha512-32yhTwoi6BZgJZhR78GwhzyFABbYG/1WwQqYgY7Vh96Demvua2jM3+FyRltIMTUH/Kd5xaQvDw2L7jTvkYFeXg==", + "dev": true, + "requires": { + "bluebird": "3.5.1", + "body-parser": "1.18.3", + "chokidar": "2.0.4", + "colors": "1.3.0", + "combine-lists": "1.0.1", + "connect": "3.6.6", + "core-js": "2.5.7", + "di": "0.0.1", + "dom-serialize": "2.2.1", + "expand-braces": "0.1.2", + "glob": "7.1.2", + "graceful-fs": "4.1.11", + "http-proxy": "1.17.0", + "isbinaryfile": "3.0.2", + "lodash": "4.17.10", + "log4js": "2.11.0", + "mime": "1.6.0", + "minimatch": "3.0.4", + "optimist": "0.6.1", + "qjobs": "1.2.0", + "range-parser": "1.2.0", + "rimraf": "2.6.2", + "safe-buffer": "5.1.2", + "socket.io": "2.0.4", + "source-map": "0.6.1", + "tmp": "0.0.33", + "useragent": "2.2.1" + } + }, + "karma-chrome-launcher": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/karma-chrome-launcher/-/karma-chrome-launcher-2.2.0.tgz", + "integrity": "sha512-uf/ZVpAabDBPvdPdveyk1EPgbnloPvFFGgmRhYLTDH7gEB4nZdSBk8yTU47w1g/drLSx5uMOkjKk7IWKfWg/+w==", + "dev": true, + "requires": { + "fs-access": "1.0.1", + "which": "1.3.1" + } + }, + "karma-firefox-launcher": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/karma-firefox-launcher/-/karma-firefox-launcher-1.1.0.tgz", + "integrity": "sha512-LbZ5/XlIXLeQ3cqnCbYLn+rOVhuMIK9aZwlP6eOLGzWdo1UVp7t6CN3DP4SafiRLjexKwHeKHDm0c38Mtd3VxA==", + "dev": true + }, + "karma-jasmine": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/karma-jasmine/-/karma-jasmine-1.1.2.tgz", + "integrity": "sha1-OU8rJf+0pkS5rabyLUQ+L9CIhsM=", + "dev": true + }, + "kind-of": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz", + "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==", + "dev": true + }, + "levn": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz", + "integrity": "sha1-OwmSTt+fCDwEkP3UwLxEIeBHZO4=", + "dev": true, + "optional": true, + "requires": { + "prelude-ls": "1.1.2", + "type-check": "0.3.2" + } + }, + "libbase64": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/libbase64/-/libbase64-0.1.0.tgz", + "integrity": "sha1-YjUag5VjrF/1vSbxL2Dpgwu3UeY=", + "dev": true + }, + "libmime": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/libmime/-/libmime-3.0.0.tgz", + "integrity": "sha1-UaGp50SOy9Ms2lRCFnW7IbwJPaY=", + "dev": true, + "requires": { + "iconv-lite": "0.4.15", + "libbase64": "0.1.0", + "libqp": "1.1.0" + }, + "dependencies": { + "iconv-lite": { + "version": "0.4.15", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.15.tgz", + "integrity": "sha1-/iZaIYrGpXz+hUkn6dBMGYJe3es=", + "dev": true + } + } + }, + "libqp": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/libqp/-/libqp-1.1.0.tgz", + "integrity": "sha1-9ebgatdLeU+1tbZpiL9yjvHe2+g=", + "dev": true + }, + "lodash": { + "version": "4.17.10", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.10.tgz", + "integrity": "sha512-UejweD1pDoXu+AD825lWwp4ZGtSwgnpZxb3JDViD7StjQz+Nb/6l093lx4OQ0foGWNRoc19mWy7BzL+UAK2iVg==", + "dev": true + }, + "lodash.debounce": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", + "integrity": "sha1-gteb/zCmfEAF/9XiUVMArZyk168=", + "dev": true + }, + "log4js": { + "version": "2.11.0", + "resolved": "https://registry.npmjs.org/log4js/-/log4js-2.11.0.tgz", + "integrity": "sha512-z1XdwyGFg8/WGkOyF6DPJjivCWNLKrklGdViywdYnSKOvgtEBo2UyEMZS5sD2mZrQlU3TvO8wDWLc8mzE1ncBQ==", + "dev": true, + "requires": { + "amqplib": "0.5.2", + "axios": "0.15.3", + "circular-json": "0.5.5", + "date-format": "1.2.0", + "debug": "3.1.0", + "hipchat-notifier": "1.1.0", + "loggly": "1.1.1", + "mailgun-js": "0.18.1", + "nodemailer": "2.7.2", + "redis": "2.8.0", + "semver": "5.5.0", + "slack-node": "0.2.0", + "streamroller": "0.7.0" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "loggly": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/loggly/-/loggly-1.1.1.tgz", + "integrity": "sha1-Cg/B0/o6XsRP3HuJe+uipGlc6+4=", + "dev": true, + "optional": true, + "requires": { + "json-stringify-safe": "5.0.1", + "request": "2.75.0", + "timespan": "2.3.0" + }, + "dependencies": { + "assert-plus": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-0.2.0.tgz", + "integrity": "sha1-104bh+ev/A24qttwIfP+SBAasjQ=", + "dev": true, + "optional": true + }, + "aws-sign2": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.6.0.tgz", + "integrity": "sha1-FDQt0428yU0OW4fXY81jYSwOeU8=", + "dev": true, + "optional": true + }, + "caseless": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.11.0.tgz", + "integrity": "sha1-cVuW6phBWTzDMGeSP17GDr2k99c=", + "dev": true, + "optional": true + }, + "form-data": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.0.0.tgz", + "integrity": "sha1-bwrrrcxdoWwT4ezBETfYX5uIOyU=", + "dev": true, + "optional": true, + "requires": { + "asynckit": "0.4.0", + "combined-stream": "1.0.6", + "mime-types": "2.1.19" + } + }, + "har-validator": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-2.0.6.tgz", + "integrity": "sha1-zcvAgYgmWtEZtqWnyKtw7s+10n0=", + "dev": true, + "optional": true, + "requires": { + "chalk": "1.1.3", + "commander": "2.16.0", + "is-my-json-valid": "2.17.2", + "pinkie-promise": "2.0.1" + } + }, + "http-signature": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.1.1.tgz", + "integrity": "sha1-33LiZwZs0Kxn+3at+OE0qPvPkb8=", + "dev": true, + "optional": true, + "requires": { + "assert-plus": "0.2.0", + "jsprim": "1.4.1", + "sshpk": "1.14.2" + } + }, + "node-uuid": { + "version": "1.4.8", + "resolved": "https://registry.npmjs.org/node-uuid/-/node-uuid-1.4.8.tgz", + "integrity": "sha1-sEDrCSOWivq/jTL7HxfxFn/auQc=", + "dev": true, + "optional": true + }, + "qs": { + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.2.3.tgz", + "integrity": "sha1-HPyyXBCpsrSDBT/zn138kjOQjP4=", + "dev": true, + "optional": true + }, + "request": { + "version": "2.75.0", + "resolved": "https://registry.npmjs.org/request/-/request-2.75.0.tgz", + "integrity": "sha1-0rgmiihtoT6qXQGt9dGMyQ9lfZM=", + "dev": true, + "optional": true, + "requires": { + "aws-sign2": "0.6.0", + "aws4": "1.7.0", + "bl": "1.1.2", + "caseless": "0.11.0", + "combined-stream": "1.0.6", + "extend": "3.0.2", + "forever-agent": "0.6.1", + "form-data": "2.0.0", + "har-validator": "2.0.6", + "hawk": "3.1.3", + "http-signature": "1.1.1", + "is-typedarray": "1.0.0", + "isstream": "0.1.2", + "json-stringify-safe": "5.0.1", + "mime-types": "2.1.19", + "node-uuid": "1.4.8", + "oauth-sign": "0.8.2", + "qs": "6.2.3", + "stringstream": "0.0.6", + "tough-cookie": "2.3.4", + "tunnel-agent": "0.4.3" + } + }, + "tunnel-agent": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.4.3.tgz", + "integrity": "sha1-Y3PbdpCf5XDgjXNYM2Xtgop07us=", + "dev": true, + "optional": true + } + } + }, + "lru-cache": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.3.tgz", + "integrity": "sha512-fFEhvcgzuIoJVUF8fYr5KR0YqxD238zgObTps31YdADwPPAp82a4M8TrckkWyx7ekNlf9aBcVn81cFwwXngrJA==", + "dev": true, + "optional": true, + "requires": { + "pseudomap": "1.0.2", + "yallist": "2.1.2" + } + }, + "mailcomposer": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/mailcomposer/-/mailcomposer-4.0.1.tgz", + "integrity": "sha1-DhxEsqB890DuF9wUm6AJ8Zyt/rQ=", + "dev": true, + "optional": true, + "requires": { + "buildmail": "4.0.1", + "libmime": "3.0.0" + } + }, + "mailgun-js": { + "version": "0.18.1", + "resolved": "https://registry.npmjs.org/mailgun-js/-/mailgun-js-0.18.1.tgz", + "integrity": "sha512-lvuMP14u24HS2uBsJEnzSyPMxzU2b99tQsIx1o6QNjqxjk8b3WvR+vq5oG1mjqz/IBYo+5gF+uSoDS0RkMVHmg==", + "dev": true, + "optional": true, + "requires": { + "async": "2.6.1", + "debug": "3.1.0", + "form-data": "2.3.2", + "inflection": "1.12.0", + "is-stream": "1.1.0", + "path-proxy": "1.0.0", + "promisify-call": "2.0.4", + "proxy-agent": "3.0.1", + "tsscmp": "1.0.5" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "optional": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "map-cache": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", + "integrity": "sha1-wyq9C9ZSXZsFFkW7TyasXcmKDb8=", + "dev": true + }, + "map-visit": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", + "integrity": "sha1-7Nyo8TFE5mDxtb1B8S80edmN+48=", + "dev": true, + "requires": { + "object-visit": "1.0.1" + } + }, + "media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=", + "dev": true + }, + "micromatch": { + "version": "3.1.10", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-3.1.10.tgz", + "integrity": "sha512-MWikgl9n9M3w+bpsY3He8L+w9eF9338xRl8IAO5viDizwSzziFEyUzo2xrrloB64ADbTf8uA8vRqqttDTOmccg==", + "dev": true, + "requires": { + "arr-diff": "4.0.0", + "array-unique": "0.3.2", + "braces": "2.3.2", + "define-property": "2.0.2", + "extend-shallow": "3.0.2", + "extglob": "2.0.4", + "fragment-cache": "0.2.1", + "kind-of": "6.0.2", + "nanomatch": "1.2.13", + "object.pick": "1.3.0", + "regex-not": "1.0.2", + "snapdragon": "0.8.2", + "to-regex": "3.0.2" + } + }, + "mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "dev": true + }, + "mime-db": { + "version": "1.35.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.35.0.tgz", + "integrity": "sha512-JWT/IcCTsB0Io3AhWUMjRqucrHSPsSf2xKLaRldJVULioggvkJvggZ3VXNNSRkCddE6D+BUI4HEIZIA2OjwIvg==", + "dev": true + }, + "mime-types": { + "version": "2.1.19", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.19.tgz", + "integrity": "sha512-P1tKYHVSZ6uFo26mtnve4HQFE3koh1UWVkp8YUC+ESBHe945xWSoXuHHiGarDqcEZ+whpCDnlNw5LON0kLo+sw==", + "dev": true, + "requires": { + "mime-db": "1.35.0" + } + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "requires": { + "brace-expansion": "1.1.11" + } + }, + "minimist": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", + "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", + "dev": true + }, + "mixin-deep": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/mixin-deep/-/mixin-deep-1.3.1.tgz", + "integrity": "sha512-8ZItLHeEgaqEvd5lYBXfm4EZSFCX29Jb9K+lAHhDKzReKBQKj3R+7NOF6tjqYi9t4oI8VUfaWITJQm86wnXGNQ==", + "dev": true, + "requires": { + "for-in": "1.0.2", + "is-extendable": "1.0.1" + }, + "dependencies": { + "is-extendable": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz", + "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", + "dev": true, + "requires": { + "is-plain-object": "2.0.4" + } + } + } + }, + "mkdirp": { + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", + "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", + "dev": true, + "requires": { + "minimist": "0.0.8" + } + }, + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", + "dev": true + }, + "nan": { + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/nan/-/nan-2.10.0.tgz", + "integrity": "sha512-bAdJv7fBLhWC+/Bls0Oza+mvTaNQtP+1RyhhhvD95pgUJz6XM5IzgmxOkItJ9tkoCiplvAnXI1tNmmUD/eScyA==", + "dev": true, + "optional": true + }, + "nanomatch": { + "version": "1.2.13", + "resolved": "https://registry.npmjs.org/nanomatch/-/nanomatch-1.2.13.tgz", + "integrity": "sha512-fpoe2T0RbHwBTBUOftAfBPaDEi06ufaUai0mE6Yn1kacc3SnTErfb/h+X94VXzI64rKFHYImXSvdwGGCmwOqCA==", + "dev": true, + "requires": { + "arr-diff": "4.0.0", + "array-unique": "0.3.2", + "define-property": "2.0.2", + "extend-shallow": "3.0.2", + "fragment-cache": "0.2.1", + "is-windows": "1.0.2", + "kind-of": "6.0.2", + "object.pick": "1.3.0", + "regex-not": "1.0.2", + "snapdragon": "0.8.2", + "to-regex": "3.0.2" + } + }, + "negotiator": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.1.tgz", + "integrity": "sha1-KzJxhOiZIQEXeyhWP7XnECrNDKk=", + "dev": true + }, + "netmask": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/netmask/-/netmask-1.0.6.tgz", + "integrity": "sha1-ICl+idhvb2QA8lDZ9Pa0wZRfzTU=", + "dev": true, + "optional": true + }, + "nodemailer": { + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-2.7.2.tgz", + "integrity": "sha1-8kLmSa7q45tsftdA73sGHEBNMPk=", + "dev": true, + "optional": true, + "requires": { + "libmime": "3.0.0", + "mailcomposer": "4.0.1", + "nodemailer-direct-transport": "3.3.2", + "nodemailer-shared": "1.1.0", + "nodemailer-smtp-pool": "2.8.2", + "nodemailer-smtp-transport": "2.7.2", + "socks": "1.1.9" + }, + "dependencies": { + "socks": { + "version": "1.1.9", + "resolved": "https://registry.npmjs.org/socks/-/socks-1.1.9.tgz", + "integrity": "sha1-Yo1+TQSRJDVEWsC25Fk3bLPm1pE=", + "dev": true, + "optional": true, + "requires": { + "ip": "1.1.5", + "smart-buffer": "1.1.15" + } + } + } + }, + "nodemailer-direct-transport": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/nodemailer-direct-transport/-/nodemailer-direct-transport-3.3.2.tgz", + "integrity": "sha1-6W+vuQNYVglH5WkBfZfmBzilCoY=", + "dev": true, + "optional": true, + "requires": { + "nodemailer-shared": "1.1.0", + "smtp-connection": "2.12.0" + } + }, + "nodemailer-fetch": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/nodemailer-fetch/-/nodemailer-fetch-1.6.0.tgz", + "integrity": "sha1-ecSQihwPXzdbc/6IjamCj23JY6Q=", + "dev": true + }, + "nodemailer-shared": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/nodemailer-shared/-/nodemailer-shared-1.1.0.tgz", + "integrity": "sha1-z1mU4v0mjQD1zw+nZ6CBae2wfsA=", + "dev": true, + "requires": { + "nodemailer-fetch": "1.6.0" + } + }, + "nodemailer-smtp-pool": { + "version": "2.8.2", + "resolved": "https://registry.npmjs.org/nodemailer-smtp-pool/-/nodemailer-smtp-pool-2.8.2.tgz", + "integrity": "sha1-LrlNbPhXgLG0clzoU7nL1ejajHI=", + "dev": true, + "optional": true, + "requires": { + "nodemailer-shared": "1.1.0", + "nodemailer-wellknown": "0.1.10", + "smtp-connection": "2.12.0" + } + }, + "nodemailer-smtp-transport": { + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/nodemailer-smtp-transport/-/nodemailer-smtp-transport-2.7.2.tgz", + "integrity": "sha1-A9ccdjFPFKx9vHvwM6am0W1n+3c=", + "dev": true, + "optional": true, + "requires": { + "nodemailer-shared": "1.1.0", + "nodemailer-wellknown": "0.1.10", + "smtp-connection": "2.12.0" + } + }, + "nodemailer-wellknown": { + "version": "0.1.10", + "resolved": "https://registry.npmjs.org/nodemailer-wellknown/-/nodemailer-wellknown-0.1.10.tgz", + "integrity": "sha1-WG24EB2zDLRDjrVGc3pBqtDPE9U=", + "dev": true + }, + "normalize-path": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", + "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=", + "dev": true, + "requires": { + "remove-trailing-separator": "1.1.0" + } + }, + "null-check": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/null-check/-/null-check-1.0.0.tgz", + "integrity": "sha1-l33/1xdgErnsMNKjnbXPcqBDnt0=", + "dev": true + }, + "oauth-sign": { + "version": "0.8.2", + "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.8.2.tgz", + "integrity": "sha1-Rqarfwrq2N6unsBWV4C31O/rnUM=", + "dev": true, + "optional": true + }, + "object-component": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/object-component/-/object-component-0.0.3.tgz", + "integrity": "sha1-8MaapQ78lbhmwYb0AKM3acsvEpE=", + "dev": true + }, + "object-copy": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/object-copy/-/object-copy-0.1.0.tgz", + "integrity": "sha1-fn2Fi3gb18mRpBupde04EnVOmYw=", + "dev": true, + "requires": { + "copy-descriptor": "0.1.1", + "define-property": "0.2.5", + "kind-of": "3.2.2" + }, + "dependencies": { + "define-property": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", + "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", + "dev": true, + "requires": { + "is-descriptor": "0.1.6" + } + }, + "kind-of": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", + "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", + "dev": true, + "requires": { + "is-buffer": "1.1.6" + } + } + } + }, + "object-visit": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz", + "integrity": "sha1-95xEk68MU3e1n+OdOV5BBC3QRbs=", + "dev": true, + "requires": { + "isobject": "3.0.1" + } + }, + "object.pick": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/object.pick/-/object.pick-1.3.0.tgz", + "integrity": "sha1-h6EKxMFpS9Lhy/U1kaZhQftd10c=", + "dev": true, + "requires": { + "isobject": "3.0.1" + } + }, + "on-finished": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", + "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", + "dev": true, + "requires": { + "ee-first": "1.1.1" + } + }, + "once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "requires": { + "wrappy": "1.0.2" + } + }, + "optimist": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/optimist/-/optimist-0.6.1.tgz", + "integrity": "sha1-2j6nRob6IaGaERwybpDrFaAZZoY=", + "dev": true, + "requires": { + "minimist": "0.0.8", + "wordwrap": "0.0.3" + }, + "dependencies": { + "wordwrap": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz", + "integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=", + "dev": true + } + } + }, + "optionator": { + "version": "0.8.2", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.2.tgz", + "integrity": "sha1-NkxeQJ0/TWMB1sC0wFu6UBgK62Q=", + "dev": true, + "optional": true, + "requires": { + "deep-is": "0.1.3", + "fast-levenshtein": "2.0.6", + "levn": "0.3.0", + "prelude-ls": "1.1.2", + "type-check": "0.3.2", + "wordwrap": "1.0.0" + } + }, + "os-tmpdir": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", + "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=", + "dev": true + }, + "pac-proxy-agent": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/pac-proxy-agent/-/pac-proxy-agent-2.0.2.tgz", + "integrity": "sha512-cDNAN1Ehjbf5EHkNY5qnRhGPUCp6SnpyVof5fRzN800QV1Y2OkzbH9rmjZkbBRa8igof903yOnjIl6z0SlAhxA==", + "dev": true, + "optional": true, + "requires": { + "agent-base": "4.2.1", + "debug": "3.1.0", + "get-uri": "2.0.2", + "http-proxy-agent": "2.1.0", + "https-proxy-agent": "2.2.1", + "pac-resolver": "3.0.0", + "raw-body": "2.3.3", + "socks-proxy-agent": "3.0.1" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "optional": true, + "requires": { + "ms": "2.0.0" + } + }, + "socks-proxy-agent": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-3.0.1.tgz", + "integrity": "sha512-ZwEDymm204mTzvdqyUqOdovVr2YRd2NYskrYrF2LXyZ9qDiMAoFESGK8CRphiO7rtbo2Y757k2Nia3x2hGtalA==", + "dev": true, + "optional": true, + "requires": { + "agent-base": "4.2.1", + "socks": "1.1.10" + } + } + } + }, + "pac-resolver": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pac-resolver/-/pac-resolver-3.0.0.tgz", + "integrity": "sha512-tcc38bsjuE3XZ5+4vP96OfhOugrX+JcnpUbhfuc4LuXBLQhoTthOstZeoQJBDnQUDYzYmdImKsbz0xSl1/9qeA==", + "dev": true, + "optional": true, + "requires": { + "co": "4.6.0", + "degenerator": "1.0.4", + "ip": "1.1.5", + "netmask": "1.0.6", + "thunkify": "2.1.2" + } + }, + "parseqs": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/parseqs/-/parseqs-0.0.5.tgz", + "integrity": "sha1-1SCKNzjkZ2bikbouoXNoSSGouJ0=", + "dev": true, + "requires": { + "better-assert": "1.0.2" + } + }, + "parseuri": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/parseuri/-/parseuri-0.0.5.tgz", + "integrity": "sha1-gCBKUNTbt3m/3G6+J3jZDkvOMgo=", + "dev": true, + "requires": { + "better-assert": "1.0.2" + } + }, + "parseurl": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.2.tgz", + "integrity": "sha1-/CidTtiZMRlGDBViUyYs3I3mW/M=", + "dev": true + }, + "pascalcase": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/pascalcase/-/pascalcase-0.1.1.tgz", + "integrity": "sha1-s2PlXoAGym/iF4TS2yK9FdeRfxQ=", + "dev": true + }, + "path-dirname": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/path-dirname/-/path-dirname-1.0.2.tgz", + "integrity": "sha1-zDPSTVJeCZpTiMAzbG4yuRYGCeA=", + "dev": true + }, + "path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true + }, + "path-proxy": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/path-proxy/-/path-proxy-1.0.0.tgz", + "integrity": "sha1-GOijaFn8nS8aU7SN7hOFQ8Ag3l4=", + "dev": true, + "optional": true, + "requires": { + "inflection": "1.3.8" + }, + "dependencies": { + "inflection": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/inflection/-/inflection-1.3.8.tgz", + "integrity": "sha1-y9Fg2p91sUw8xjV41POWeEvzAU4=", + "dev": true, + "optional": true + } + } + }, + "performance-now": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", + "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=", + "dev": true, + "optional": true + }, + "pinkie": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/pinkie/-/pinkie-2.0.4.tgz", + "integrity": "sha1-clVrgM+g1IqXToDnckjoDtT3+HA=", + "dev": true, + "optional": true + }, + "pinkie-promise": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pinkie-promise/-/pinkie-promise-2.0.1.tgz", + "integrity": "sha1-ITXW36ejWMBprJsXh3YogihFD/o=", + "dev": true, + "optional": true, + "requires": { + "pinkie": "2.0.4" + } + }, + "posix-character-classes": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz", + "integrity": "sha1-AerA/jta9xoqbAL+q7jB/vfgDqs=", + "dev": true + }, + "prelude-ls": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz", + "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", + "dev": true + }, + "process-nextick-args": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.0.tgz", + "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==", + "dev": true + }, + "promisify-call": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/promisify-call/-/promisify-call-2.0.4.tgz", + "integrity": "sha1-1IwtRWUszM1SgB3ey9UzptS9X7o=", + "dev": true, + "optional": true, + "requires": { + "with-callback": "1.0.2" + } + }, + "proxy-agent": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/proxy-agent/-/proxy-agent-3.0.1.tgz", + "integrity": "sha512-mAZexaz9ZxQhYPWfAjzlrloEjW+JHiBFryE4AJXFDTnaXfmH/FKqC1swTRKuEPbHWz02flQNXFOyDUF7zfEG6A==", + "dev": true, + "optional": true, + "requires": { + "agent-base": "4.2.1", + "debug": "3.1.0", + "http-proxy-agent": "2.1.0", + "https-proxy-agent": "2.2.1", + "lru-cache": "4.1.3", + "pac-proxy-agent": "2.0.2", + "proxy-from-env": "1.0.0", + "socks-proxy-agent": "4.0.1" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "optional": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "proxy-from-env": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.0.0.tgz", + "integrity": "sha1-M8UDmPcOp+uW0h97gXYwpVeRx+4=", + "dev": true, + "optional": true + }, + "pseudomap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz", + "integrity": "sha1-8FKijacOYYkX7wqKw0wa5aaChrM=", + "dev": true, + "optional": true + }, + "punycode": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", + "integrity": "sha1-wNWmOycYgArY4esPpSachN1BhF4=", + "dev": true, + "optional": true + }, + "qjobs": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/qjobs/-/qjobs-1.2.0.tgz", + "integrity": "sha512-8YOJEHtxpySA3fFDyCRxA+UUV+fA+rTWnuWvylOK/NCjhY+b4ocCtmu8TtsWb+mYeU+GCHf/S66KZF/AsteKHg==", + "dev": true + }, + "qs": { + "version": "6.5.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", + "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==", + "dev": true + }, + "range-parser": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", + "integrity": "sha1-9JvmtIeJTdxA3MlKMi9hEJLgDV4=", + "dev": true + }, + "raw-body": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.3.3.tgz", + "integrity": "sha512-9esiElv1BrZoI3rCDuOuKCBRbuApGGaDPQfjSflGxdy4oyzqghxu6klEkkVIvBje+FF0BX9coEv8KqW6X/7njw==", + "dev": true, + "requires": { + "bytes": "3.0.0", + "http-errors": "1.6.3", + "iconv-lite": "0.4.23", + "unpipe": "1.0.0" + } + }, + "readable-stream": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", + "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", + "dev": true, + "requires": { + "core-util-is": "1.0.2", + "inherits": "2.0.3", + "isarray": "1.0.0", + "process-nextick-args": "2.0.0", + "safe-buffer": "5.1.2", + "string_decoder": "1.1.1", + "util-deprecate": "1.0.2" + } + }, + "readdirp": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-2.1.0.tgz", + "integrity": "sha1-TtCtBg3zBzMAxIRANz9y0cxkLXg=", + "dev": true, + "requires": { + "graceful-fs": "4.1.11", + "minimatch": "3.0.4", + "readable-stream": "2.3.6", + "set-immediate-shim": "1.0.1" + } + }, + "redis": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/redis/-/redis-2.8.0.tgz", + "integrity": "sha512-M1OkonEQwtRmZv4tEWF2VgpG0JWJ8Fv1PhlgT5+B+uNq2cA3Rt1Yt/ryoR+vQNOQcIEgdCdfH0jr3bDpihAw1A==", + "dev": true, + "optional": true, + "requires": { + "double-ended-queue": "2.1.0-0", + "redis-commands": "1.3.5", + "redis-parser": "2.6.0" + } + }, + "redis-commands": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.3.5.tgz", + "integrity": "sha512-foGF8u6MXGFF++1TZVC6icGXuMYPftKXt1FBT2vrfU9ZATNtZJ8duRC5d1lEfE8hyVe3jhelHGB91oB7I6qLsA==", + "dev": true, + "optional": true + }, + "redis-parser": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/redis-parser/-/redis-parser-2.6.0.tgz", + "integrity": "sha1-Uu0J2srBCPGmMcB+m2mUHnoZUEs=", + "dev": true, + "optional": true + }, + "regex-not": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz", + "integrity": "sha512-J6SDjUgDxQj5NusnOtdFxDwN/+HWykR8GELwctJ7mdqhcyy1xEc4SRFHUXvxTp661YaVKAjfRLZ9cCqS6tn32A==", + "dev": true, + "requires": { + "extend-shallow": "3.0.2", + "safe-regex": "1.1.0" + } + }, + "remove-trailing-separator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz", + "integrity": "sha1-wkvOKig62tW8P1jg1IJJuSN52O8=", + "dev": true + }, + "repeat-element": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/repeat-element/-/repeat-element-1.1.2.tgz", + "integrity": "sha1-7wiaF40Ug7quTZPrmLT55OEdmQo=", + "dev": true + }, + "repeat-string": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", + "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", + "dev": true + }, + "request": { + "version": "2.87.0", + "resolved": "https://registry.npmjs.org/request/-/request-2.87.0.tgz", + "integrity": "sha512-fcogkm7Az5bsS6Sl0sibkbhcKsnyon/jV1kF3ajGmF0c8HrttdKTPRT9hieOaQHA5HEq6r8OyWOo/o781C1tNw==", + "dev": true, + "optional": true, + "requires": { + "aws-sign2": "0.7.0", + "aws4": "1.7.0", + "caseless": "0.12.0", + "combined-stream": "1.0.6", + "extend": "3.0.2", + "forever-agent": "0.6.1", + "form-data": "2.3.2", + "har-validator": "5.0.3", + "http-signature": "1.2.0", + "is-typedarray": "1.0.0", + "isstream": "0.1.2", + "json-stringify-safe": "5.0.1", + "mime-types": "2.1.19", + "oauth-sign": "0.8.2", + "performance-now": "2.1.0", + "qs": "6.5.2", + "safe-buffer": "5.1.2", + "tough-cookie": "2.3.4", + "tunnel-agent": "0.6.0", + "uuid": "3.3.2" + } + }, + "requestretry": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/requestretry/-/requestretry-1.13.0.tgz", + "integrity": "sha512-Lmh9qMvnQXADGAQxsXHP4rbgO6pffCfuR8XUBdP9aitJcLQJxhp7YZK4xAVYXnPJ5E52mwrfiKQtKonPL8xsmg==", + "dev": true, + "optional": true, + "requires": { + "extend": "3.0.2", + "lodash": "4.17.10", + "request": "2.87.0", + "when": "3.7.8" + } + }, + "requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha1-kl0mAdOaxIXgkc8NpcbmlNw9yv8=", + "dev": true + }, + "resolve-url": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/resolve-url/-/resolve-url-0.2.1.tgz", + "integrity": "sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo=", + "dev": true + }, + "ret": { + "version": "0.1.15", + "resolved": "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz", + "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", + "dev": true + }, + "rimraf": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.2.tgz", + "integrity": "sha512-lreewLK/BlghmxtfH36YYVg1i8IAce4TI7oao75I1g245+6BctqTVQiBP3YUJ9C6DQOXJmkYR9X9fCLtCOJc5w==", + "dev": true, + "requires": { + "glob": "7.1.2" + } + }, + "safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "dev": true + }, + "safe-regex": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-1.1.0.tgz", + "integrity": "sha1-QKNmnzsHfR6UPURinhV91IAjvy4=", + "dev": true, + "requires": { + "ret": "0.1.15" + } + }, + "safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "dev": true + }, + "semver": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.5.0.tgz", + "integrity": "sha512-4SJ3dm0WAwWy/NVeioZh5AntkdJoWKxHxcmyP622fOkgHa4z3R0TdBJICINyaSDE6uNwVc8gZr+ZinwZAH4xIA==", + "dev": true + }, + "set-immediate-shim": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/set-immediate-shim/-/set-immediate-shim-1.0.1.tgz", + "integrity": "sha1-SysbJ+uAip+NzEgaWOXlb1mfP2E=", + "dev": true + }, + "set-value": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.0.tgz", + "integrity": "sha512-hw0yxk9GT/Hr5yJEYnHNKYXkIA8mVJgd9ditYZCe16ZczcaELYYcfvaXesNACk2O8O0nTiPQcQhGUQj8JLzeeg==", + "dev": true, + "requires": { + "extend-shallow": "2.0.1", + "is-extendable": "0.1.1", + "is-plain-object": "2.0.4", + "split-string": "3.1.0" + }, + "dependencies": { + "extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "dev": true, + "requires": { + "is-extendable": "0.1.1" + } + } + } + }, + "setprototypeof": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz", + "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==", + "dev": true + }, + "slack-node": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/slack-node/-/slack-node-0.2.0.tgz", + "integrity": "sha1-3kuN3aqLeT9h29KTgQT9q/N9+jA=", + "dev": true, + "optional": true, + "requires": { + "requestretry": "1.13.0" + } + }, + "smart-buffer": { + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-1.1.15.tgz", + "integrity": "sha1-fxFLW2X6s+KjWqd1uxLw0cZJvxY=", + "dev": true, + "optional": true + }, + "smtp-connection": { + "version": "2.12.0", + "resolved": "https://registry.npmjs.org/smtp-connection/-/smtp-connection-2.12.0.tgz", + "integrity": "sha1-1275EnyyPCJZ7bHoNJwujV4tdME=", + "dev": true, + "requires": { + "httpntlm": "1.6.1", + "nodemailer-shared": "1.1.0" + } + }, + "snapdragon": { + "version": "0.8.2", + "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz", + "integrity": "sha512-FtyOnWN/wCHTVXOMwvSv26d+ko5vWlIDD6zoUJ7LW8vh+ZBC8QdljveRP+crNrtBwioEUWy/4dMtbBjA4ioNlg==", + "dev": true, + "requires": { + "base": "0.11.2", + "debug": "2.6.9", + "define-property": "0.2.5", + "extend-shallow": "2.0.1", + "map-cache": "0.2.2", + "source-map": "0.5.7", + "source-map-resolve": "0.5.2", + "use": "3.1.1" + }, + "dependencies": { + "define-property": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", + "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", + "dev": true, + "requires": { + "is-descriptor": "0.1.6" + } + }, + "extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "dev": true, + "requires": { + "is-extendable": "0.1.1" + } + }, + "source-map": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz", + "integrity": "sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=", + "dev": true + } + } + }, + "snapdragon-node": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/snapdragon-node/-/snapdragon-node-2.1.1.tgz", + "integrity": "sha512-O27l4xaMYt/RSQ5TR3vpWCAB5Kb/czIcqUFOM/C4fYcLnbZUc1PkjTAMjof2pBWaSTwOUd6qUHcFGVGj7aIwnw==", + "dev": true, + "requires": { + "define-property": "1.0.0", + "isobject": "3.0.1", + "snapdragon-util": "3.0.1" + }, + "dependencies": { + "define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", + "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", + "dev": true, + "requires": { + "is-descriptor": "1.0.2" + } + }, + "is-accessor-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", + "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-data-descriptor": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", + "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", + "dev": true, + "requires": { + "kind-of": "6.0.2" + } + }, + "is-descriptor": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", + "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", + "dev": true, + "requires": { + "is-accessor-descriptor": "1.0.0", + "is-data-descriptor": "1.0.0", + "kind-of": "6.0.2" + } + } + } + }, + "snapdragon-util": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/snapdragon-util/-/snapdragon-util-3.0.1.tgz", + "integrity": "sha512-mbKkMdQKsjX4BAL4bRYTj21edOf8cN7XHdYUJEe+Zn99hVEYcMvKPct1IqNe7+AZPirn8BCDOQBHQZknqmKlZQ==", + "dev": true, + "requires": { + "kind-of": "3.2.2" + }, + "dependencies": { + "kind-of": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", + "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", + "dev": true, + "requires": { + "is-buffer": "1.1.6" + } + } + } + }, + "sntp": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/sntp/-/sntp-1.0.9.tgz", + "integrity": "sha1-ZUEYTMkK7qbG57NeJlkIJEPGYZg=", + "dev": true, + "optional": true, + "requires": { + "hoek": "2.16.3" + } + }, + "socket.io": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-2.0.4.tgz", + "integrity": "sha1-waRZDO/4fs8TxyZS8Eb3FrKeYBQ=", + "dev": true, + "requires": { + "debug": "2.6.9", + "engine.io": "3.1.5", + "socket.io-adapter": "1.1.1", + "socket.io-client": "2.0.4", + "socket.io-parser": "3.1.3" + } + }, + "socket.io-adapter": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-1.1.1.tgz", + "integrity": "sha1-KoBeihTWNyEk3ZFZrUUC+MsH8Gs=", + "dev": true + }, + "socket.io-client": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-2.0.4.tgz", + "integrity": "sha1-CRilUkBtxeVAs4Dc2Xr8SmQzL44=", + "dev": true, + "requires": { + "backo2": "1.0.2", + "base64-arraybuffer": "0.1.5", + "component-bind": "1.0.0", + "component-emitter": "1.2.1", + "debug": "2.6.9", + "engine.io-client": "3.1.6", + "has-cors": "1.1.0", + "indexof": "0.0.1", + "object-component": "0.0.3", + "parseqs": "0.0.5", + "parseuri": "0.0.5", + "socket.io-parser": "3.1.3", + "to-array": "0.1.4" + } + }, + "socket.io-parser": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-3.1.3.tgz", + "integrity": "sha512-g0a2HPqLguqAczs3dMECuA1RgoGFPyvDqcbaDEdCWY9g59kdUAz3YRmaJBNKXflrHNwB7Q12Gkf/0CZXfdHR7g==", + "dev": true, + "requires": { + "component-emitter": "1.2.1", + "debug": "3.1.0", + "has-binary2": "1.0.3", + "isarray": "2.0.1" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + }, + "isarray": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.1.tgz", + "integrity": "sha1-o32U7ZzaLVmGXJ92/llu4fM4dB4=", + "dev": true + } + } + }, + "socks": { + "version": "1.1.10", + "resolved": "https://registry.npmjs.org/socks/-/socks-1.1.10.tgz", + "integrity": "sha1-W4t/x8jzQcU+0FbpKbe/Tei6e1o=", + "dev": true, + "optional": true, + "requires": { + "ip": "1.1.5", + "smart-buffer": "1.1.15" + } + }, + "socks-proxy-agent": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-4.0.1.tgz", + "integrity": "sha512-Kezx6/VBguXOsEe5oU3lXYyKMi4+gva72TwJ7pQY5JfqUx2nMk7NXA6z/mpNqIlfQjWYVfeuNvQjexiTaTn6Nw==", + "dev": true, + "optional": true, + "requires": { + "agent-base": "4.2.1", + "socks": "2.2.1" + }, + "dependencies": { + "smart-buffer": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.0.1.tgz", + "integrity": "sha512-RFqinRVJVcCAL9Uh1oVqE6FZkqsyLiVOYEZ20TqIOjuX7iFVJ+zsbs4RIghnw/pTs7mZvt8ZHhvm1ZUrR4fykg==", + "dev": true, + "optional": true + }, + "socks": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/socks/-/socks-2.2.1.tgz", + "integrity": "sha512-0GabKw7n9mI46vcNrVfs0o6XzWzjVa3h6GaSo2UPxtWAROXUWavfJWh1M4PR5tnE0dcnQXZIDFP4yrAysLze/w==", + "dev": true, + "optional": true, + "requires": { + "ip": "1.1.5", + "smart-buffer": "4.0.1" + } + } + } + }, + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + }, + "source-map-resolve": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.2.tgz", + "integrity": "sha512-MjqsvNwyz1s0k81Goz/9vRBe9SZdB09Bdw+/zYyO+3CuPk6fouTaxscHkgtE8jKvf01kVfl8riHzERQ/kefaSA==", + "dev": true, + "requires": { + "atob": "2.1.1", + "decode-uri-component": "0.2.0", + "resolve-url": "0.2.1", + "source-map-url": "0.4.0", + "urix": "0.1.0" + } + }, + "source-map-url": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.0.tgz", + "integrity": "sha1-PpNdfd1zYxuXZZlW1VEo6HtQhKM=", + "dev": true + }, + "split-string": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/split-string/-/split-string-3.1.0.tgz", + "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==", + "dev": true, + "requires": { + "extend-shallow": "3.0.2" + } + }, + "sshpk": { + "version": "1.14.2", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.14.2.tgz", + "integrity": "sha1-xvxhZIo9nE52T9P8306hBeSSupg=", + "dev": true, + "optional": true, + "requires": { + "asn1": "0.2.3", + "assert-plus": "1.0.0", + "bcrypt-pbkdf": "1.0.2", + "dashdash": "1.14.1", + "ecc-jsbn": "0.1.1", + "getpass": "0.1.7", + "jsbn": "0.1.1", + "safer-buffer": "2.1.2", + "tweetnacl": "0.14.5" + } + }, + "static-extend": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/static-extend/-/static-extend-0.1.2.tgz", + "integrity": "sha1-YICcOcv/VTNyJv1eC1IPNB8ftcY=", + "dev": true, + "requires": { + "define-property": "0.2.5", + "object-copy": "0.1.0" + }, + "dependencies": { + "define-property": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", + "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", + "dev": true, + "requires": { + "is-descriptor": "0.1.6" + } + } + } + }, + "statuses": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", + "integrity": "sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=", + "dev": true + }, + "streamroller": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/streamroller/-/streamroller-0.7.0.tgz", + "integrity": "sha512-WREzfy0r0zUqp3lGO096wRuUp7ho1X6uo/7DJfTlEi0Iv/4gT7YHqXDjKC2ioVGBZtE8QzsQD9nx1nIuoZ57jQ==", + "dev": true, + "requires": { + "date-format": "1.2.0", + "debug": "3.1.0", + "mkdirp": "0.5.1", + "readable-stream": "2.3.6" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } + } + }, + "string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "requires": { + "safe-buffer": "5.1.2" + } + }, + "stringstream": { + "version": "0.0.6", + "resolved": "https://registry.npmjs.org/stringstream/-/stringstream-0.0.6.tgz", + "integrity": "sha512-87GEBAkegbBcweToUrdzf3eLhWNg06FJTebl4BVJz/JgWy8CvEr9dRtX5qWphiynMSQlxxi+QqN0z5T32SLlhA==", + "dev": true, + "optional": true + }, + "strip-ansi": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", + "dev": true, + "optional": true, + "requires": { + "ansi-regex": "2.1.1" + } + }, + "supports-color": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz", + "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc=", + "dev": true, + "optional": true + }, + "thunkify": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/thunkify/-/thunkify-2.1.2.tgz", + "integrity": "sha1-+qDp0jDFGsyVyhOjYawFyn4EVT0=", + "dev": true, + "optional": true + }, + "timespan": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/timespan/-/timespan-2.3.0.tgz", + "integrity": "sha1-SQLOBAvRPYRcj1myfp1ZutbzmSk=", + "dev": true, + "optional": true + }, + "tmp": { + "version": "0.0.33", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", + "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", + "dev": true, + "requires": { + "os-tmpdir": "1.0.2" + } + }, + "to-array": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/to-array/-/to-array-0.1.4.tgz", + "integrity": "sha1-F+bBH3PdTz10zaek/zI46a2b+JA=", + "dev": true + }, + "to-object-path": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/to-object-path/-/to-object-path-0.3.0.tgz", + "integrity": "sha1-KXWIt7Dn4KwI4E5nL4XB9JmeF68=", + "dev": true, + "requires": { + "kind-of": "3.2.2" + }, + "dependencies": { + "kind-of": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", + "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", + "dev": true, + "requires": { + "is-buffer": "1.1.6" + } + } + } + }, + "to-regex": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/to-regex/-/to-regex-3.0.2.tgz", + "integrity": "sha512-FWtleNAtZ/Ki2qtqej2CXTOayOH9bHDQF+Q48VpWyDXjbYxA4Yz8iDB31zXOBUlOHHKidDbqGVrTUvQMPmBGBw==", + "dev": true, + "requires": { + "define-property": "2.0.2", + "extend-shallow": "3.0.2", + "regex-not": "1.0.2", + "safe-regex": "1.1.0" + } + }, + "to-regex-range": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-2.1.1.tgz", + "integrity": "sha1-fIDBe53+vlmeJzZ+DU3VWQFB2zg=", + "dev": true, + "requires": { + "is-number": "3.0.0", + "repeat-string": "1.6.1" + } + }, + "tough-cookie": { + "version": "2.3.4", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.3.4.tgz", + "integrity": "sha512-TZ6TTfI5NtZnuyy/Kecv+CnoROnyXn2DN97LontgQpCwsX2XyLYCC0ENhYkehSOwAp8rTQKc/NUIF7BkQ5rKLA==", + "dev": true, + "optional": true, + "requires": { + "punycode": "1.4.1" + } + }, + "tsscmp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/tsscmp/-/tsscmp-1.0.5.tgz", + "integrity": "sha1-fcSjOvcVgatDN9qR2FylQn69mpc=", + "dev": true, + "optional": true + }, + "tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", + "dev": true, + "optional": true, + "requires": { + "safe-buffer": "5.1.2" + } + }, + "tweetnacl": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", + "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=", + "dev": true, + "optional": true + }, + "type-check": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", + "integrity": "sha1-WITKtRLPHTVeP7eE8wgEsrUg23I=", + "dev": true, + "requires": { + "prelude-ls": "1.1.2" + } + }, + "type-is": { + "version": "1.6.16", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.16.tgz", + "integrity": "sha512-HRkVv/5qY2G6I8iab9cI7v1bOIdhm94dVjQCPFElW9W+3GeDOSHmy2EBYe4VTApuzolPcmgFTN3ftVJRKR2J9Q==", + "dev": true, + "requires": { + "media-typer": "0.3.0", + "mime-types": "2.1.19" + } + }, + "ultron": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ultron/-/ultron-1.1.1.tgz", + "integrity": "sha512-UIEXBNeYmKptWH6z8ZnqTeS8fV74zG0/eRU9VGkpzz+LIJNs8W/zM/L+7ctCkRrgbNnnR0xxw4bKOr0cW0N0Og==", + "dev": true + }, + "underscore": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.7.0.tgz", + "integrity": "sha1-a7rwh3UA02vjTsqlhODbn+8DUgk=", + "dev": true + }, + "union-value": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.0.tgz", + "integrity": "sha1-XHHDTLW61dzr4+oM0IIHulqhrqQ=", + "dev": true, + "requires": { + "arr-union": "3.1.0", + "get-value": "2.0.6", + "is-extendable": "0.1.1", + "set-value": "0.4.3" + }, + "dependencies": { + "extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "dev": true, + "requires": { + "is-extendable": "0.1.1" + } + }, + "set-value": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/set-value/-/set-value-0.4.3.tgz", + "integrity": "sha1-fbCPnT0i3H945Trzw79GZuzfzPE=", + "dev": true, + "requires": { + "extend-shallow": "2.0.1", + "is-extendable": "0.1.1", + "is-plain-object": "2.0.4", + "to-object-path": "0.3.0" + } + } + } + }, + "unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=", + "dev": true + }, + "unset-value": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unset-value/-/unset-value-1.0.0.tgz", + "integrity": "sha1-g3aHP30jNRef+x5vw6jtDfyKtVk=", + "dev": true, + "requires": { + "has-value": "0.3.1", + "isobject": "3.0.1" + }, + "dependencies": { + "has-value": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/has-value/-/has-value-0.3.1.tgz", + "integrity": "sha1-ex9YutpiyoJ+wKIHgCVlSEWZXh8=", + "dev": true, + "requires": { + "get-value": "2.0.6", + "has-values": "0.1.4", + "isobject": "2.1.0" + }, + "dependencies": { + "isobject": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-2.1.0.tgz", + "integrity": "sha1-8GVWEJaj8dou9GJy+BXIQNh+DIk=", + "dev": true, + "requires": { + "isarray": "1.0.0" + } + } + } + }, + "has-values": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/has-values/-/has-values-0.1.4.tgz", + "integrity": "sha1-bWHeldkd/Km5oCCJrThL/49it3E=", + "dev": true + } + } + }, + "upath": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/upath/-/upath-1.1.0.tgz", + "integrity": "sha512-bzpH/oBhoS/QI/YtbkqCg6VEiPYjSZtrHQM6/QnJS6OL9pKUFLqb3aFh4Scvwm45+7iAgiMkLhSbaZxUqmrprw==", + "dev": true + }, + "urix": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/urix/-/urix-0.1.0.tgz", + "integrity": "sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI=", + "dev": true + }, + "use": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/use/-/use-3.1.1.tgz", + "integrity": "sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ==", + "dev": true + }, + "useragent": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/useragent/-/useragent-2.2.1.tgz", + "integrity": "sha1-z1k+9PLRdYdei7ZY6pLhik/QbY4=", + "dev": true, + "requires": { + "lru-cache": "2.2.4", + "tmp": "0.0.33" + }, + "dependencies": { + "lru-cache": { + "version": "2.2.4", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-2.2.4.tgz", + "integrity": "sha1-bGWGGb7PFAMdDQtZSxYELOTcBj0=", + "dev": true + } + } + }, + "util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", + "dev": true + }, + "utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha1-n5VxD1CiZ5R7LMwSR0HBAoQn5xM=", + "dev": true + }, + "uuid": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.2.tgz", + "integrity": "sha512-yXJmeNaw3DnnKAOKJE51sL/ZaYfWJRl1pK9dr19YFCu0ObS231AB1/LbqTKRAQ5kw8A90rA6fr4riOUpTZvQZA==", + "dev": true, + "optional": true + }, + "uws": { + "version": "9.14.0", + "resolved": "https://registry.npmjs.org/uws/-/uws-9.14.0.tgz", + "integrity": "sha512-HNMztPP5A1sKuVFmdZ6BPVpBQd5bUjNC8EFMFiICK+oho/OQsAJy5hnIx4btMHiOk8j04f/DbIlqnEZ9d72dqg==", + "dev": true, + "optional": true + }, + "verror": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", + "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", + "dev": true, + "optional": true, + "requires": { + "assert-plus": "1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "1.3.0" + } + }, + "void-elements": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/void-elements/-/void-elements-2.0.1.tgz", + "integrity": "sha1-wGavtYK7HLQSjWDqkjkulNXp2+w=", + "dev": true + }, + "when": { + "version": "3.7.8", + "resolved": "https://registry.npmjs.org/when/-/when-3.7.8.tgz", + "integrity": "sha1-xxMLan6gRpPoQs3J56Hyqjmjn4I=", + "dev": true, + "optional": true + }, + "which": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", + "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "dev": true, + "requires": { + "isexe": "2.0.0" + } + }, + "with-callback": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/with-callback/-/with-callback-1.0.2.tgz", + "integrity": "sha1-oJYpuakgAo1yFAT7Q1vc/1yRvCE=", + "dev": true, + "optional": true + }, + "wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", + "dev": true, + "optional": true + }, + "wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "ws": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/ws/-/ws-3.3.3.tgz", + "integrity": "sha512-nnWLa/NwZSt4KQJu51MYlCcSQ5g7INpOrOMt4XV8j4dqTXdmlUmSHQ8/oLC069ckre0fRsgfvsKwbTdtKLCDkA==", + "dev": true, + "requires": { + "async-limiter": "1.0.0", + "safe-buffer": "5.1.2", + "ultron": "1.1.1" + } + }, + "xmlhttprequest-ssl": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-1.5.5.tgz", + "integrity": "sha1-wodrBhaKrcQOV9l+gRkayPQ5iz4=", + "dev": true + }, + "xregexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/xregexp/-/xregexp-2.0.0.tgz", + "integrity": "sha1-UqY+VsoLhKfzpfPWGHLxJq16WUM=", + "dev": true, + "optional": true + }, + "xtend": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz", + "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68=", + "dev": true, + "optional": true + }, + "yallist": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", + "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=", + "dev": true, + "optional": true + }, + "yeast": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/yeast/-/yeast-0.1.2.tgz", + "integrity": "sha1-AI4G2AlDIMNy28L47XagymyKxBk=", + "dev": true + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 000000000..e5939c9b3 --- /dev/null +++ b/package.json @@ -0,0 +1,20 @@ +{ + "name": "sphinx", + "scripts": { + "test": "test" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/sphinx-doc/sphinx.git" + }, + "bugs": { + "url": "https://github.com/sphinx-doc/sphinx/issues" + }, + "devDependencies": { + "jasmine-core": "^3.1.0", + "karma": "^2.0.4", + "karma-chrome-launcher": "^2.2.0", + "karma-firefox-launcher": "^1.1.0", + "karma-jasmine": "^1.1.2" + } +} diff --git a/tests/js/doctools.js b/tests/js/doctools.js new file mode 100644 index 000000000..32fd68c10 --- /dev/null +++ b/tests/js/doctools.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = {}; + +describe('urldecode', function() { + + it('should fail', function() { + var test_encoded_string = + '%D1%88%D0%B5%D0%BB%D0%BB%D1%8B+%D1%88%D0%B5%D0%BB%D0%BB%D1%8B'; + var test_decoded_string = 'шеллы шеллы'; + expect(jQuery.urldecode(test_encoded_string)).toEqual(test_decoded_string); + }); + +}); From da08da385d644440376dc73cdb6e1fd23fbff23e Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sun, 22 Jul 2018 14:42:45 +0200 Subject: [PATCH 038/174] #5190 add new co-maintainer --- AUTHORS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS b/AUTHORS index 8fd867481..1cbb20137 100644 --- a/AUTHORS +++ b/AUTHORS @@ -14,6 +14,7 @@ Other co-maintainers: * Takeshi Komiya <@tk0miya> * Jean-François Burnol <@jfbu> * Yoshiki Shibukawa <@shibu_jp> +* Timotheus Kampik - <@TimKam> Other contributors, listed alphabetically, are: @@ -37,7 +38,6 @@ Other contributors, listed alphabetically, are: * Zac Hatfield-Dodds -- doctest reporting improvements * Doug Hellmann -- graphviz improvements * Tim Hoffmann -- theme improvements -* Timotheus Kampik - JS theme & search enhancements * Dave Kuhlman -- original LaTeX writer * Blaise Laflamme -- pyramid theme * Chris Lamb -- reproducibility fixes From e3483e9b045584380563d8783ab13bc620af5f27 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 19 Jul 2018 23:48:19 +0900 Subject: [PATCH 039/174] Closes #4614: sphinx-build: Add :option:`--keep-going` option to show all warnings --- CHANGES | 1 + doc/man/sphinx-build.rst | 7 +++++++ sphinx/application.py | 13 ++++++++++--- sphinx/cmd/build.py | 4 +++- 4 files changed, 21 insertions(+), 4 deletions(-) diff --git a/CHANGES b/CHANGES index cb4237ce9..2af40bbdb 100644 --- a/CHANGES +++ b/CHANGES @@ -162,6 +162,7 @@ Features added if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter * #5122: setuptools: support nitpicky option +* #4614: sphinx-build: Add ``--keep-going`` option to show all warnings Bugs fixed ---------- diff --git a/doc/man/sphinx-build.rst b/doc/man/sphinx-build.rst index 72235efad..f7194a955 100644 --- a/doc/man/sphinx-build.rst +++ b/doc/man/sphinx-build.rst @@ -229,6 +229,13 @@ Options Turn warnings into errors. This means that the build stops at the first warning and ``sphinx-build`` exits with exit status 1. +.. option:: --keep-going + + With -W option, keep going processing when getting warnings to the end + of build, and ``sphinx-build`` exits with exit status 1. + + .. versionadded:: 1.8 + .. option:: -T Display the full traceback when an unhandled exception occurs. Otherwise, diff --git a/sphinx/application.py b/sphinx/application.py index 2bf40e115..50eae966e 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -128,8 +128,8 @@ class Sphinx(object): def __init__(self, srcdir, confdir, outdir, doctreedir, buildername, confoverrides=None, status=sys.stdout, warning=sys.stderr, freshenv=False, warningiserror=False, tags=None, verbosity=0, - parallel=0): - # type: (unicode, unicode, unicode, unicode, unicode, Dict, IO, IO, bool, bool, List[unicode], int, int) -> None # NOQA + parallel=0, keep_going=False): + # type: (unicode, unicode, unicode, unicode, unicode, Dict, IO, IO, bool, bool, List[unicode], int, int, bool) -> None # NOQA self.phase = BuildPhase.INITIALIZATION self.verbosity = verbosity self.extensions = {} # type: Dict[unicode, Extension] @@ -172,7 +172,11 @@ class Sphinx(object): else: self._warning = warning self._warncount = 0 - self.warningiserror = warningiserror + self.keep_going = warningiserror and keep_going + if self.keep_going: + self.warningiserror = False + else: + self.warningiserror = warningiserror logging.setup(self, self._status, self._warning) self.events = EventManager() @@ -334,6 +338,9 @@ class Sphinx(object): self.builder.compile_update_catalogs() self.builder.build_update() + if self._warncount and self.keep_going: + self.statuscode = 1 + status = (self.statuscode == 0 and __('succeeded') or __('finished with problems')) if self._warncount: diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index 86a1b5633..57d3e3eea 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -189,6 +189,8 @@ files can be built by specifying individual filenames. help=__('write warnings (and errors) to given file')) group.add_argument('-W', action='store_true', dest='warningiserror', help=__('turn warnings into errors')) + group.add_argument('--keep-going', action='store_true', dest='keep_going', + help=__("With -W, Keep going when getting warnings")) group.add_argument('-T', action='store_true', dest='traceback', help=__('show full traceback on exception')) group.add_argument('-P', action='store_true', dest='pdb', @@ -298,7 +300,7 @@ def build_main(argv=sys.argv[1:]): # type: ignore app = Sphinx(args.sourcedir, args.confdir, args.outputdir, args.doctreedir, args.builder, confoverrides, status, warning, args.freshenv, args.warningiserror, - args.tags, args.verbosity, args.jobs) + args.tags, args.verbosity, args.jobs, args.keep_going) app.build(args.force_all, filenames) return app.statuscode except (Exception, KeyboardInterrupt) as exc: From 1ab2ea7ff0e6de25577e5dc302e7e86e8bc5d0a4 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 7 Mar 2018 15:11:28 +0900 Subject: [PATCH 040/174] epub: spine has been broken because of "self" in toctree --- CHANGES | 1 + sphinx/builders/_epub_base.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index cb4237ce9..d19a1beff 100644 --- a/CHANGES +++ b/CHANGES @@ -174,6 +174,7 @@ Bugs fixed * #5132: (lualatex) PDF build fails if indexed word starts with Unicode character * #5133: latex: index headings "Symbols" and "Numbers" not internationalized * #5114: sphinx-build: Handle errors on scanning documents +* epub: spine has been broken when "self" is listed on toctree (refs: #4611) Testing -------- diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py index 2a975fa94..eaab43fda 100644 --- a/sphinx/builders/_epub_base.py +++ b/sphinx/builders/_epub_base.py @@ -195,7 +195,7 @@ class EpubBuilder(StandaloneHTMLBuilder): """Collect section titles, their depth in the toc and the refuri.""" # XXX: is there a better way than checking the attribute # toctree-l[1-8] on the parent node? - if isinstance(doctree, nodes.reference) and 'refuri' in doctree: + if isinstance(doctree, nodes.reference) and doctree.get('refuri'): refuri = doctree['refuri'] if refuri.startswith('http://') or refuri.startswith('https://') \ or refuri.startswith('irc:') or refuri.startswith('mailto:'): From 2fa382673fd36bd4701ad63beefa2e66c33358c3 Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sun, 22 Jul 2018 12:39:11 +0200 Subject: [PATCH 041/174] #5186 configure travis-ci --- .travis.yml | 13 +++++++++++-- package.json | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 86d7559ca..f4a9d32af 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,6 +7,7 @@ env: global: - PYTHONFAULTHANDLER=x - SKIP_LATEX_BUILD=1 + - RUN_TOX=true matrix: include: @@ -33,11 +34,19 @@ matrix: - python: '3.6' env: TOXENV=flake8 + - language: node_js + node_js: + - 10.7 + env: RUN_TOX=false + before_script: + - export DISPLAY=:99.0 + - sh -e /etc/init.d/xvfb start + install: - - pip install -U tox codecov + - if [ $RUN_TOX = true ]; then pip install -U tox codecov; fi script: - - tox -- -v + - if [ $RUN_TOX = true ]; then tox -- -v; fi after_success: - if [[ -e .coverage ]]; then codecov -e $TOXENV; fi diff --git a/package.json b/package.json index e5939c9b3..8e7d36d2c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "sphinx", "scripts": { - "test": "test" + "test": "./node_modules/.bin/karma start --browsers Firefox --single-run" }, "repository": { "type": "git", From 5ed3f0ad52d92292702b78152a56d5f8132a7074 Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sun, 22 Jul 2018 20:20:32 +0200 Subject: [PATCH 042/174] #5186 add contrib doc for JS tests --- CONTRIBUTING.rst | 13 +++++++++++-- sphinx/themes/basic/static/searchtools.js | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6736e4c72..19c03c496 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -154,6 +154,12 @@ These are the basic steps needed to start developing on Sphinx. tox -e docs -- -b html,latexpdf + * To run JavaScript tests with `Karma `_, + execute the following commands (requires `Node.js `_):: + + npm install + npm run test + You can also test by installing dependencies in your local environment. :: pip install .[test] @@ -302,8 +308,8 @@ Debugging Tips in `this repository `_. You can get the resulting JavaScript files using the following command:: - $ npm install - $ node_modules/.bin/grunt build # -> dest/*.global.js + npm install + node_modules/.bin/grunt build # -> dest/*.global.js Branch Model @@ -402,3 +408,6 @@ and other ``test_*.py`` files under ``tests`` directory. .. versionadded:: 1.6 ``sphinx.testing`` as a experimental. + +.. versionadded:: 1.8 + Sphinx also runs JavaScript tests. diff --git a/sphinx/themes/basic/static/searchtools.js b/sphinx/themes/basic/static/searchtools.js index 34d7db2e3..7473859b2 100644 --- a/sphinx/themes/basic/static/searchtools.js +++ b/sphinx/themes/basic/static/searchtools.js @@ -1,5 +1,5 @@ /* - * searchtools.js_t + * searchtools.js * ~~~~~~~~~~~~~~~~ * * Sphinx JavaScript utilities for the full-text search. From aa424e9003d2b7c405e8edb1cb0bae2c336137d5 Mon Sep 17 00:00:00 2001 From: jfbu Date: Fri, 20 Jul 2018 15:47:00 +0200 Subject: [PATCH 043/174] LaTeX: correct usage of xindy with Latin scripts (refs: #5134) --- .../{cyrLICRutf8.xdy => LICRcyr2utf8.xdy} | 2 +- sphinx/texinputs/LICRlatin2utf8.xdy | 236 ++++++++++++++++++ sphinx/texinputs/Makefile_t | 10 +- sphinx/texinputs/sphinx.xdy | 18 +- 4 files changed, 256 insertions(+), 10 deletions(-) rename sphinx/texinputs/{cyrLICRutf8.xdy => LICRcyr2utf8.xdy} (99%) create mode 100644 sphinx/texinputs/LICRlatin2utf8.xdy diff --git a/sphinx/texinputs/cyrLICRutf8.xdy b/sphinx/texinputs/LICRcyr2utf8.xdy similarity index 99% rename from sphinx/texinputs/cyrLICRutf8.xdy rename to sphinx/texinputs/LICRcyr2utf8.xdy index 8aabde9b3..a9ca1c82c 100644 --- a/sphinx/texinputs/cyrLICRutf8.xdy +++ b/sphinx/texinputs/LICRcyr2utf8.xdy @@ -1,6 +1,6 @@ ;; -*- coding: utf-8; mode: Lisp; -*- ;; style file for xindy -;; filename: cyrLICRutf8.xdy +;; filename: LICRcyr2utf8.xdy ;; description: style file for xindy which maps back LaTeX Internal ;; Character Representation of Cyrillic to utf-8 ;; usage: for use with pdflatex produced .idx files. diff --git a/sphinx/texinputs/LICRlatin2utf8.xdy b/sphinx/texinputs/LICRlatin2utf8.xdy new file mode 100644 index 000000000..60a24b421 --- /dev/null +++ b/sphinx/texinputs/LICRlatin2utf8.xdy @@ -0,0 +1,236 @@ +;; style file for xindy +;; filename: LICRlatin2utf8.xdy +;; description: style file for xindy which maps back LaTeX Internal +;; Character Representation of letters (as arising in .idx index +;; file) to UTF-8 encoding for correct sorting by xindy. +;; usage: for use with the pdflatex engine, +;; *not* for use with xelatex or lualatex. +;; +;; This is based upon xindy's distributed file tex/inputenc/utf8.xdy. +;; The modifications include: +;; +;; - Updates for compatibility with current LaTeX macro encoding. +;; +;; - Systematic usage of the \IeC {...} mark-up, because mark-up in +;; tex/inputenc/utf8.xdy was using it on seemingly random basis, and +;; Sphinx coercing of xindy usability for both Latin and Cyrillic scripts +;; with pdflatex requires its systematic presence here. +;; +;; - Support for some extra letters: Ÿ, Ŋ, ŋ, Œ, œ, IJ, ij, ȷ and ẞ. +;; +;; Indeed Sphinx needs to support for pdflatex engine all Unicode letters +;; available in TeX T1 font encoding. The above letters are found in +;; that encoding but not in the Latin1, 2, 3 charsets which are those +;; covered by original tex/inputenc/utf8.xdy. +;; +;; - There is a problem that ȷ is not supported out-of-the box by LaTeX +;; with inputenc, one must add explicitely +;; \DeclareUnicodeCharacter{0237}{\j} +;; to preamble of LaTeX document. However this character is not supported +;; by the TeX "times" font used by default by Sphinx for pdflatex engine. +;; +;; - ẞ needs \DeclareUnicodeCharacter{1E9E}{\SS} (but ß needs no extra set-up). +;; +;; - U+02DB (˛) and U+02D9 (˙) are also not supported by inputenc +;; out of the box and require +;; \DeclareUnicodeCharacter{02DB}{\k{}} +;; \DeclareUnicodeCharacter{02D9}{\.{}} +;; to be added to preamble. +;; +;; - U+0127 ħ and U+0126 Ħ are absent from TeX T1+TS1 font encodings. +;; +;; - Characters Ŋ and ŋ are not supported by TeX font "times" used by +;; default by Sphinx for pdflatex engine but they are supported by +;; some TeX fonts, in particular by the default LaTeX font for T1 +;; encoding. +;; +;; - " and ~ must be escaped as ~" and resp. ~~ in xindy merge rules. +;; +;; Contributed by the Sphinx team, July 2018. +;; +;; See sphinx.xdy for superior figures, as they are escaped by LaTeX writer. +(merge-rule "\IeC {\textonesuperior }" "¹" :string) +(merge-rule "\IeC {\texttwosuperior }" "²" :string) +(merge-rule "\IeC {\textthreesuperior }" "³" :string) +(merge-rule "\IeC {\'a}" "á" :string) +(merge-rule "\IeC {\'A}" "Á" :string) +(merge-rule "\IeC {\`a}" "à" :string) +(merge-rule "\IeC {\`A}" "À" :string) +(merge-rule "\IeC {\^a}" "â" :string) +(merge-rule "\IeC {\^A}" "Â" :string) +(merge-rule "\IeC {\~"a}" "ä" :string) +(merge-rule "\IeC {\~"A}" "Ä" :string) +(merge-rule "\IeC {\~~a}" "ã" :string) +(merge-rule "\IeC {\~~A}" "Ã" :string) +(merge-rule "\IeC {\c c}" "ç" :string) +(merge-rule "\IeC {\c C}" "Ç" :string) +(merge-rule "\IeC {\'c}" "ć" :string) +(merge-rule "\IeC {\'C}" "Ć" :string) +(merge-rule "\IeC {\^c}" "ĉ" :string) +(merge-rule "\IeC {\^C}" "Ĉ" :string) +(merge-rule "\IeC {\.c}" "ċ" :string) +(merge-rule "\IeC {\.C}" "Ċ" :string) +(merge-rule "\IeC {\c s}" "ş" :string) +(merge-rule "\IeC {\c S}" "Ş" :string) +(merge-rule "\IeC {\c t}" "ţ" :string) +(merge-rule "\IeC {\c T}" "Ţ" :string) +(merge-rule "\IeC {\-}" "­" :string); soft hyphen +(merge-rule "\IeC {\textdiv }" "÷" :string) +(merge-rule "\IeC {\'e}" "é" :string) +(merge-rule "\IeC {\'E}" "É" :string) +(merge-rule "\IeC {\`e}" "è" :string) +(merge-rule "\IeC {\`E}" "È" :string) +(merge-rule "\IeC {\^e}" "ê" :string) +(merge-rule "\IeC {\^E}" "Ê" :string) +(merge-rule "\IeC {\~"e}" "ë" :string) +(merge-rule "\IeC {\~"E}" "Ë" :string) +(merge-rule "\IeC {\^g}" "ĝ" :string) +(merge-rule "\IeC {\^G}" "Ĝ" :string) +(merge-rule "\IeC {\.g}" "ġ" :string) +(merge-rule "\IeC {\.G}" "Ġ" :string) +(merge-rule "\IeC {\^h}" "ĥ" :string) +(merge-rule "\IeC {\^H}" "Ĥ" :string) +(merge-rule "\IeC {\H o}" "ő" :string) +(merge-rule "\IeC {\H O}" "Ő" :string) +(merge-rule "\IeC {\textacutedbl }" "˝" :string) +(merge-rule "\IeC {\H u}" "ű" :string) +(merge-rule "\IeC {\H U}" "Ű" :string) +(merge-rule "\IeC {\ae }" "æ" :string) +(merge-rule "\IeC {\AE }" "Æ" :string) +(merge-rule "\IeC {\textcopyright }" "©" :string) +(merge-rule "\IeC {\c \ }" "¸" :string) +(merge-rule "\IeC {\dh }" "ð" :string) +(merge-rule "\IeC {\DH }" "Ð" :string) +(merge-rule "\IeC {\dj }" "đ" :string) +(merge-rule "\IeC {\DJ }" "Đ" :string) +(merge-rule "\IeC {\guillemotleft }" "«" :string) +(merge-rule "\IeC {\guillemotright }" "»" :string) +(merge-rule "\IeC {\'\i }" "í" :string) +(merge-rule "\IeC {\`\i }" "ì" :string) +(merge-rule "\IeC {\^\i }" "î" :string) +(merge-rule "\IeC {\~"\i }" "ï" :string) +(merge-rule "\IeC {\i }" "ı" :string) +(merge-rule "\IeC {\^\j }" "ĵ" :string) +(merge-rule "\IeC {\k {}}" "˛" :string) +(merge-rule "\IeC {\l }" "ł" :string) +(merge-rule "\IeC {\L }" "Ł" :string) +(merge-rule "\IeC {\nobreakspace }" " " :string) +(merge-rule "\IeC {\o }" "ø" :string) +(merge-rule "\IeC {\O }" "Ø" :string) +(merge-rule "\IeC {\textsterling }" "£" :string) +(merge-rule "\IeC {\textparagraph }" "¶" :string) +(merge-rule "\IeC {\ss }" "ß" :string) +(merge-rule "\IeC {\textsection }" "§" :string) +(merge-rule "\IeC {\textbrokenbar }" "¦" :string) +(merge-rule "\IeC {\textcent }" "¢" :string) +(merge-rule "\IeC {\textcurrency }" "¤" :string) +(merge-rule "\IeC {\textdegree }" "°" :string) +(merge-rule "\IeC {\textexclamdown }" "¡" :string) +(merge-rule "\IeC {\texthbar }" "ħ" :string) +(merge-rule "\IeC {\textHbar }" "Ħ" :string) +(merge-rule "\IeC {\textonehalf }" "½" :string) +(merge-rule "\IeC {\textonequarter }" "¼" :string) +(merge-rule "\IeC {\textordfeminine }" "ª" :string) +(merge-rule "\IeC {\textordmasculine }" "º" :string) +(merge-rule "\IeC {\textperiodcentered }" "·" :string) +(merge-rule "\IeC {\textquestiondown }" "¿" :string) +(merge-rule "\IeC {\textregistered }" "®" :string) +(merge-rule "\IeC {\textthreequarters }" "¾" :string) +(merge-rule "\IeC {\textyen }" "¥" :string) +(merge-rule "\IeC {\th }" "þ" :string) +(merge-rule "\IeC {\TH }" "Þ" :string) +(merge-rule "\IeC {\'I}" "Í" :string) +(merge-rule "\IeC {\`I}" "Ì" :string) +(merge-rule "\IeC {\^I}" "Î" :string) +(merge-rule "\IeC {\~"I}" "Ï" :string) +(merge-rule "\IeC {\.I}" "İ" :string) +(merge-rule "\IeC {\^J}" "Ĵ" :string) +(merge-rule "\IeC {\k a}" "ą" :string) +(merge-rule "\IeC {\k A}" "Ą" :string) +(merge-rule "\IeC {\k e}" "ę" :string) +(merge-rule "\IeC {\k E}" "Ę" :string) +(merge-rule "\IeC {\'l}" "ĺ" :string) +(merge-rule "\IeC {\'L}" "Ĺ" :string) +(merge-rule "\IeC {\textlnot }" "¬" :string) +(merge-rule "\IeC {\textmu }" "µ" :string) +(merge-rule "\IeC {\'n}" "ń" :string) +(merge-rule "\IeC {\'N}" "Ń" :string) +(merge-rule "\IeC {\~~n}" "ñ" :string) +(merge-rule "\IeC {\~~N}" "Ñ" :string) +(merge-rule "\IeC {\'o}" "ó" :string) +(merge-rule "\IeC {\'O}" "Ó" :string) +(merge-rule "\IeC {\`o}" "ò" :string) +(merge-rule "\IeC {\`O}" "Ò" :string) +(merge-rule "\IeC {\^o}" "ô" :string) +(merge-rule "\IeC {\^O}" "Ô" :string) +(merge-rule "\IeC {\~"o}" "ö" :string) +(merge-rule "\IeC {\~"O}" "Ö" :string) +(merge-rule "\IeC {\~~o}" "õ" :string) +(merge-rule "\IeC {\~~O}" "Õ" :string) +(merge-rule "\IeC {\textpm }" "±" :string) +(merge-rule "\IeC {\r a}" "å" :string) +(merge-rule "\IeC {\r A}" "Å" :string) +(merge-rule "\IeC {\'r}" "ŕ" :string) +(merge-rule "\IeC {\'R}" "Ŕ" :string) +(merge-rule "\IeC {\r u}" "ů" :string) +(merge-rule "\IeC {\r U}" "Ů" :string) +(merge-rule "\IeC {\'s}" "ś" :string) +(merge-rule "\IeC {\'S}" "Ś" :string) +(merge-rule "\IeC {\^s}" "ŝ" :string) +(merge-rule "\IeC {\^S}" "Ŝ" :string) +(merge-rule "\IeC {\textasciidieresis }" "¨" :string) +(merge-rule "\IeC {\textasciimacron }" "¯" :string) +(merge-rule "\IeC {\.{}}" "˙" :string) +(merge-rule "\IeC {\textasciiacute }" "´" :string) +(merge-rule "\IeC {\texttimes }" "×" :string) +(merge-rule "\IeC {\u a}" "ă" :string) +(merge-rule "\IeC {\u A}" "Ă" :string) +(merge-rule "\IeC {\u g}" "ğ" :string) +(merge-rule "\IeC {\u G}" "Ğ" :string) +(merge-rule "\IeC {\textasciibreve }" "˘" :string) +(merge-rule "\IeC {\'u}" "ú" :string) +(merge-rule "\IeC {\'U}" "Ú" :string) +(merge-rule "\IeC {\`u}" "ù" :string) +(merge-rule "\IeC {\`U}" "Ù" :string) +(merge-rule "\IeC {\^u}" "û" :string) +(merge-rule "\IeC {\^U}" "Û" :string) +(merge-rule "\IeC {\~"u}" "ü" :string) +(merge-rule "\IeC {\~"U}" "Ü" :string) +(merge-rule "\IeC {\u u}" "ŭ" :string) +(merge-rule "\IeC {\u U}" "Ŭ" :string) +(merge-rule "\IeC {\v c}" "č" :string) +(merge-rule "\IeC {\v C}" "Č" :string) +(merge-rule "\IeC {\v d}" "ď" :string) +(merge-rule "\IeC {\v D}" "Ď" :string) +(merge-rule "\IeC {\v e}" "ě" :string) +(merge-rule "\IeC {\v E}" "Ě" :string) +(merge-rule "\IeC {\v l}" "ľ" :string) +(merge-rule "\IeC {\v L}" "Ľ" :string) +(merge-rule "\IeC {\v n}" "ň" :string) +(merge-rule "\IeC {\v N}" "Ň" :string) +(merge-rule "\IeC {\v r}" "ř" :string) +(merge-rule "\IeC {\v R}" "Ř" :string) +(merge-rule "\IeC {\v s}" "š" :string) +(merge-rule "\IeC {\v S}" "Š" :string) +(merge-rule "\IeC {\textasciicaron }" "ˇ" :string) +(merge-rule "\IeC {\v t}" "ť" :string) +(merge-rule "\IeC {\v T}" "Ť" :string) +(merge-rule "\IeC {\v z}" "ž" :string) +(merge-rule "\IeC {\v Z}" "Ž" :string) +(merge-rule "\IeC {\'y}" "ý" :string) +(merge-rule "\IeC {\'Y}" "Ý" :string) +(merge-rule "\IeC {\~"y}" "ÿ" :string) +(merge-rule "\IeC {\'z}" "ź" :string) +(merge-rule "\IeC {\'Z}" "Ź" :string) +(merge-rule "\IeC {\.z}" "ż" :string) +(merge-rule "\IeC {\.Z}" "Ż" :string) +;; letters not in Latin1, 2, 3 but available in TeX T1 font encoding +(merge-rule "\IeC {\~"Y}" "Ÿ" :string) +(merge-rule "\IeC {\NG }" "Ŋ" :string) +(merge-rule "\IeC {\ng }" "ŋ" :string) +(merge-rule "\IeC {\OE }" "Œ" :string) +(merge-rule "\IeC {\oe }" "œ" :string) +(merge-rule "\IeC {\IJ }" "IJ" :string) +(merge-rule "\IeC {\ij }" "ij" :string) +(merge-rule "\IeC {\j }" "ȷ" :string) +(merge-rule "\IeC {\SS }" "ẞ" :string) diff --git a/sphinx/texinputs/Makefile_t b/sphinx/texinputs/Makefile_t index 1ce4b1324..5e686e44e 100644 --- a/sphinx/texinputs/Makefile_t +++ b/sphinx/texinputs/Makefile_t @@ -24,13 +24,15 @@ export LATEXOPTS = LATEXMKOPTS = {% if xindy_use -%} export XINDYOPTS = {{ xindy_lang_option }} -M sphinx.xdy -{% if latex_engine == 'pdflatex' and xindy_cyrillic -%} -XINDYOPTS += -M cyrLICRutf8.xdy +{% if latex_engine == 'pdflatex' -%} +XINDYOPTS += -M LICRlatin2utf8.xdy +{% if xindy_cyrillic -%} +XINDYOPTS += -M LICRcyr2utf8.xdy {% endif -%} -{% if latex_engine == 'xelatex' or latex_engine == 'lualatex' -%} +{% endif -%} +# also with pdflatex as LICRlatin2utf8.xdy replaces xindy's /tex/inputenc/utf8.xdy XINDYOPTS += -I xelatex {% endif -%} -{% endif -%} # format: pdf or dvi (used only by archive targets) FMT = pdf diff --git a/sphinx/texinputs/sphinx.xdy b/sphinx/texinputs/sphinx.xdy index 5f1fa3aaf..fff9c4a8c 100644 --- a/sphinx/texinputs/sphinx.xdy +++ b/sphinx/texinputs/sphinx.xdy @@ -26,7 +26,7 @@ ;; man page says to use rather xelatex or lualatex in case of Cyrillic ;; scripts. -;; Sphinx contributes cyrLICRutf8.xdy to provide support for Cyrillic +;; Sphinx contributes LICRcyr2utf8.xdy to provide support for Cyrillic ;; scripts for the pdflatex engine. ;; Another issue caused by xindy ignoring all TeX macros except those @@ -42,6 +42,14 @@ ;; Rather it incorporates some suitable extracts from latex.xdy and ;; tex.xdy with additional Sphinx contributed rules. +;; But, this means for pdflatex and Latin scripts that the xindy file +;; tex/inputenc/uf8.xdy is not usable because it refers to the macro +;; \IeC only sporadically, and as tex.xdy is not loaded, a rule such as +;; (merge-rule "\'e" "é" :string) +;; does not work, it must be +;; (merge-rule "\IeC {\'e}" "é" :string) +;; So Sphinx contributes LICRlatin2utf8.xdy to mitigate that problem. + ;;;;;;;; extracts from tex.xdy (discarding most original comments): ;;; @@ -84,12 +92,10 @@ ;;;;;;;; end of extracts from latex.xdy -;; Sphinx additions, cf sphinx.util.texescape for rationale -;; ;; The LaTeX \index command turns \ into normal character so the TeX macros ;; written to .idx files are not followed by a blank. This is different ;; from non-ascii letters which end up (with pdflatex) as \IeC macros in .idx -;; file, with a blank. +;; file, with a blank space after \IeC ;; Details of the syntax are explained at ;; http://xindy.sourceforge.net/doc/manual-3.html @@ -98,6 +104,8 @@ ;; guess, for example "\\_" is not detected as RE but "\\P\{\}" is, so for ;; being sure we apply the :string switch everywhere and do not use \\ etc... +;; Go back from sphinx.util.texescape TeX macros to UTF-8 + (merge-rule "\sphinxleftcurlybrace{}" "{" :string) (merge-rule "\sphinxrightcurlybrace{}" "}" :string) (merge-rule "\_" "_" :string) @@ -123,7 +131,7 @@ (require "makeindex.xdy") ;; This creates one-letter headings and works fine with utf-8 letters. -;; For Cyrillic and pdflatex necessitates cyrLICRutf8.xdy to be loaded too. +;; For Cyrillic with pdflatex works thanks to LICRcyr2utf8.xdy (require "latin-lettergroups.xdy") ;; currently we don't (know how to easily) separate "Numbers" from From 5aca2031c58c2123474260909b7613e34113a745 Mon Sep 17 00:00:00 2001 From: jfbu Date: Fri, 20 Jul 2018 18:26:11 +0200 Subject: [PATCH 044/174] LaTeX: add xindy merge rules for superior and inferior figures --- sphinx/texinputs/sphinx.xdy | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/sphinx/texinputs/sphinx.xdy b/sphinx/texinputs/sphinx.xdy index fff9c4a8c..bf187ae4c 100644 --- a/sphinx/texinputs/sphinx.xdy +++ b/sphinx/texinputs/sphinx.xdy @@ -126,6 +126,26 @@ (merge-rule "\(\checkmark\)" "✓" :string) (merge-rule "\textendash{}" "–" :string) (merge-rule "\textbar{}" "|" :string) +(merge-rule "\(\sp{\text{0}}\)" "⁰" :string) +(merge-rule "\(\sp{\text{1}}\)" "¹" :string) +(merge-rule "\(\sp{\text{2}}\)" "²" :string) +(merge-rule "\(\sp{\text{3}}\)" "³" :string) +(merge-rule "\(\sp{\text{4}}\)" "⁴" :string) +(merge-rule "\(\sp{\text{5}}\)" "⁵" :string) +(merge-rule "\(\sp{\text{6}}\)" "⁶" :string) +(merge-rule "\(\sp{\text{7}}\)" "⁷" :string) +(merge-rule "\(\sp{\text{8}}\)" "⁸" :string) +(merge-rule "\(\sp{\text{9}}\)" "⁹" :string) +(merge-rule "\(\sb{\text{0}}\)" "₀" :string) +(merge-rule "\(\sb{\text{1}}\)" "₁" :string) +(merge-rule "\(\sb{\text{2}}\)" "₂" :string) +(merge-rule "\(\sb{\text{3}}\)" "₃" :string) +(merge-rule "\(\sb{\text{4}}\)" "₄" :string) +(merge-rule "\(\sb{\text{5}}\)" "₅" :string) +(merge-rule "\(\sb{\text{6}}\)" "₆" :string) +(merge-rule "\(\sb{\text{7}}\)" "₇" :string) +(merge-rule "\(\sb{\text{8}}\)" "₈" :string) +(merge-rule "\(\sb{\text{9}}\)" "₉" :string) ;; This xindy module provides some basic support for "see" (require "makeindex.xdy") From b3d89f94179022e9633a5c5fa68e38b349c7f34d Mon Sep 17 00:00:00 2001 From: jfbu Date: Fri, 20 Jul 2018 20:31:04 +0200 Subject: [PATCH 045/174] LaTeX: add xindy merge rules for TeX-escaped Greek letters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The effect is that indexed Greek letters are sorted with uppercase Greek letters before lowercase Greek: ΓΔΘ...αβγ...; without this commit the Greek letters are ordered according to the ascii characters used in the TeX control sequences as set-up in sphinx.util.texescape, i.e. the order is αβχΔδεηΓγ... In both cases indexed terms starting with such a Greek letter end up in the same group as terms starting with a non-letter. This commit does not create letter-groups for Greek letters, as such letter-groups would require to make sure non-escaped letters such as α are accepted by TeX engine, and this requires extra-steps for pdflatex (or OpenType font with Greek script for xelatex/lualatex), and if those steps were made default by Sphinx, there would not be a reason anymore to escape via sphinx.util.texescape the Greek letters from rest source. --- sphinx/texinputs/sphinx.xdy | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/sphinx/texinputs/sphinx.xdy b/sphinx/texinputs/sphinx.xdy index bf187ae4c..17b065600 100644 --- a/sphinx/texinputs/sphinx.xdy +++ b/sphinx/texinputs/sphinx.xdy @@ -146,6 +146,40 @@ (merge-rule "\(\sb{\text{7}}\)" "₇" :string) (merge-rule "\(\sb{\text{8}}\)" "₈" :string) (merge-rule "\(\sb{\text{9}}\)" "₉" :string) +(merge-rule "\(\alpha\)" "α" :string) +(merge-rule "\(\beta\)" "β" :string) +(merge-rule "\(\gamma\)" "γ" :string) +(merge-rule "\(\delta\)" "δ" :string) +(merge-rule "\(\epsilon\)" "ε" :string) +(merge-rule "\(\zeta\)" "ζ" :string) +(merge-rule "\(\eta\)" "η" :string) +(merge-rule "\(\theta\)" "θ" :string) +(merge-rule "\(\iota\)" "ι" :string) +(merge-rule "\(\kappa\)" "κ" :string) +(merge-rule "\(\lambda\)" "λ" :string) +(merge-rule "\(\mu\)" "μ" :string) +(merge-rule "\(\nu\)" "ν" :string) +(merge-rule "\(\xi\)" "ξ" :string) +(merge-rule "\(\pi\)" "π" :string) +(merge-rule "\(\rho\)" "ρ" :string) +(merge-rule "\(\sigma\)" "σ" :string) +(merge-rule "\(\tau\)" "τ" :string) +(merge-rule "\(\upsilon\)" "υ" :string) +(merge-rule "\(\phi\)" "φ" :string) +(merge-rule "\(\chi\)" "χ" :string) +(merge-rule "\(\psi\)" "ψ" :string) +(merge-rule "\(\omega\)" "ω" :string) +(merge-rule "\(\Gamma\)" "Γ" :string) +(merge-rule "\(\Delta\)" "Δ" :string) +(merge-rule "\(\Theta\)" "Θ" :string) +(merge-rule "\(\Lambda\)" "Λ" :string) +(merge-rule "\(\Xi\)" "Ξ" :string) +(merge-rule "\(\Pi\)" "Π" :string) +(merge-rule "\(\Sigma\)" "Σ" :string) +(merge-rule "\(\Upsilon\)" "Υ" :string) +(merge-rule "\(\Phi\)" "Φ" :string) +(merge-rule "\(\Psi\)" "Ψ" :string) +(merge-rule "\(\Omega\)" "Ω" :string) ;; This xindy module provides some basic support for "see" (require "makeindex.xdy") From 5193c2aa2262fc6324b0348ac220519c0220a185 Mon Sep 17 00:00:00 2001 From: jfbu Date: Sun, 22 Jul 2018 18:38:47 +0200 Subject: [PATCH 046/174] LaTeX: index Latin names with diacritics in Cyrillic documents --- sphinx/texinputs/Makefile_t | 2 +- sphinx/texinputs/sphinx-basiclatin.xdy | 42 -- sphinx/texinputs/sphinx-isolatin.xdy | 606 +++++++++++++++++++++++++ 3 files changed, 607 insertions(+), 43 deletions(-) delete mode 100644 sphinx/texinputs/sphinx-basiclatin.xdy create mode 100644 sphinx/texinputs/sphinx-isolatin.xdy diff --git a/sphinx/texinputs/Makefile_t b/sphinx/texinputs/Makefile_t index f385ae18b..0b715481a 100644 --- a/sphinx/texinputs/Makefile_t +++ b/sphinx/texinputs/Makefile_t @@ -31,7 +31,7 @@ XINDYOPTS += -M LICRcyr2utf8.xdy {% endif -%} {% endif -%} {% if xindy_cyrillic -%} -XINDYOPTS += -M sphinx-basiclatin.xdy +XINDYOPTS += -M sphinx-isolatin.xdy {% endif -%} # also with pdflatex as LICRlatin2utf8.xdy replaces xindy's /tex/inputenc/utf8.xdy XINDYOPTS += -I xelatex diff --git a/sphinx/texinputs/sphinx-basiclatin.xdy b/sphinx/texinputs/sphinx-basiclatin.xdy deleted file mode 100644 index f611ac5ca..000000000 --- a/sphinx/texinputs/sphinx-basiclatin.xdy +++ /dev/null @@ -1,42 +0,0 @@ -;; xindy style file to provide indexing of (ascii) Latin names -;; in an otherwise non-Latin (i.e. Cyrillic) context. -;; TODO: should we support also iso-latin-1 ? -;; Contributed by the Sphinx team, July 2018. - -(define-letter-groups - ("A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" - "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z")) - -(define-rule-set "latin-toupper" - - :rules (("a" "A" :string :again) - ("b" "B" :string :again) - ("c" "C" :string :again) - ("d" "D" :string :again) - ("e" "E" :string :again) - ("f" "F" :string :again) - ("g" "G" :string :again) - ("h" "H" :string :again) - ("i" "I" :string :again) - ("j" "J" :string :again) - ("k" "K" :string :again) - ("l" "L" :string :again) - ("m" "M" :string :again) - ("n" "N" :string :again) - ("o" "O" :string :again) - ("p" "P" :string :again) - ("q" "Q" :string :again) - ("r" "R" :string :again) - ("s" "S" :string :again) - ("t" "T" :string :again) - ("u" "U" :string :again) - ("v" "V" :string :again) - ("w" "W" :string :again) - ("x" "X" :string :again) - ("y" "Y" :string :again) - ("z" "Z" :string :again) - )) - -(use-rule-set - :run 0 - :rule-set ("latin-toupper")) diff --git a/sphinx/texinputs/sphinx-isolatin.xdy b/sphinx/texinputs/sphinx-isolatin.xdy new file mode 100644 index 000000000..7757f9d99 --- /dev/null +++ b/sphinx/texinputs/sphinx-isolatin.xdy @@ -0,0 +1,606 @@ +;; style file for xindy +;; filename: sphinx-isolatin.xdy +;; +;; It is based upon xindy's files lang/general/utf8.xdy and +;; lang/general/utf8-lang.xdy which implement +;; "a general sorting order for Western European languages" +;; +;; The aim for Sphinx is to be able to index in a Cyrillic document +;; also terms using the Latin alphabets, inclusive of letters +;; with diacritics. To this effect the xindy rules from lang/general +;; got manually re-coded to avoid collisions with the encoding +;; done by xindy for sorting words in Cyrillic languages, which was +;; observed not to use bytes with octal encoding 0o266 or higher. +;; +;; So here we use only 0o266 or higher bytes. +;; +;; Contributed by the Sphinx team, 2018. + +(define-letter-group "A" :prefixes ("")) +(define-letter-group "B" :after "A" :prefixes ("")) +(define-letter-group "C" :after "B" :prefixes ("")) +(define-letter-group "D" :after "C" :prefixes ("")) +(define-letter-group "E" :after "D" :prefixes ("")) +(define-letter-group "F" :after "E" :prefixes ("")) +(define-letter-group "G" :after "F" :prefixes ("")) +(define-letter-group "H" :after "G" :prefixes ("")) +(define-letter-group "I" :after "H" :prefixes ("")) +(define-letter-group "J" :after "I" :prefixes ("")) +(define-letter-group "K" :after "J" :prefixes ("")) +(define-letter-group "L" :after "K" :prefixes ("")) +(define-letter-group "M" :after "L" :prefixes ("")) +(define-letter-group "N" :after "M" :prefixes ("")) +(define-letter-group "O" :after "N" :prefixes ("")) +(define-letter-group "P" :after "O" :prefixes ("")) +(define-letter-group "Q" :after "P" :prefixes ("")) +(define-letter-group "R" :after "Q" :prefixes ("")) +(define-letter-group "S" :after "R" :prefixes ("")) +(define-letter-group "T" :after "S" :prefixes ("")) +(define-letter-group "U" :after "T" :prefixes ("")) +(define-letter-group "V" :after "U" :prefixes ("")) +(define-letter-group "W" :after "V" :prefixes ("")) +(define-letter-group "X" :after "W" :prefixes ("")) +(define-letter-group "Y" :after "X" :prefixes ("")) +(define-letter-group "Z" :after "Y" :prefixes ("")) + +(define-rule-set "sphinx-xy-alphabetize" + + :rules (("À" "" :string) + ("Ă" "" :string) + ("â" "" :string) + ("Ä" "" :string) + ("à" "" :string) + ("Å" "" :string) + ("Ã" "" :string) + ("Á" "" :string) + ("á" "" :string) + ("ã" "" :string) + ("Â" "" :string) + ("ă" "" :string) + ("å" "" :string) + ("ą" "" :string) + ("ä" "" :string) + ("Ą" "" :string) + ("æ" "" :string) + ("Æ" "" :string) + ("ć" "" :string) + ("ĉ" "" :string) + ("ç" "" :string) + ("Č" "" :string) + ("č" "" :string) + ("Ĉ" "" :string) + ("Ç" "" :string) + ("Ć" "" :string) + ("ď" "" :string) + ("Đ" "" :string) + ("Ď" "" :string) + ("đ" "" :string) + ("ê" "" :string) + ("Ę" "" :string) + ("Ě" "" :string) + ("ë" "" :string) + ("ě" "" :string) + ("é" "" :string) + ("È" "" :string) + ("Ë" "" :string) + ("É" "" :string) + ("è" "" :string) + ("Ê" "" :string) + ("ę" "" :string) + ("ĝ" "" :string) + ("ğ" "" :string) + ("Ğ" "" :string) + ("Ĝ" "" :string) + ("ĥ" "" :string) + ("Ĥ" "" :string) + ("Ï" "" :string) + ("Í" "" :string) + ("ï" "" :string) + ("Î" "" :string) + ("î" "" :string) + ("ı" "" :string) + ("İ" "" :string) + ("í" "" :string) + ("Ì" "" :string) + ("ì" "" :string) + ("Ĵ" "" :string) + ("ĵ" "" :string) + ("ł" "" :string) + ("Ł" "" :string) + ("ľ" "" :string) + ("Ľ" "" :string) + ("ń" "" :string) + ("Ń" "" :string) + ("ñ" "" :string) + ("ň" "" :string) + ("Ñ" "" :string) + ("Ň" "" :string) + ("Õ" "" :string) + ("Ő" "" :string) + ("ó" "" :string) + ("ö" "" :string) + ("ô" "" :string) + ("ő" "" :string) + ("Ø" "" :string) + ("Ö" "" :string) + ("õ" "" :string) + ("Ô" "" :string) + ("ø" "" :string) + ("Ó" "" :string) + ("Ò" "" :string) + ("ò" "" :string) + ("œ" "ĺ" :string) + ("Œ" "ĺ" :string) + ("Ř" "" :string) + ("ř" "" :string) + ("Ŕ" "" :string) + ("ŕ" "" :string) + ("ŝ" "" :string) + ("Ś" "" :string) + ("ș" "" :string) + ("ş" "" :string) + ("Ŝ" "" :string) + ("ś" "" :string) + ("Ș" "" :string) + ("š" "" :string) + ("Ş" "" :string) + ("Š" "" :string) + ("ß" "" :string) + ("Ț" "" :string) + ("Ť" "" :string) + ("ț" "" :string) + ("ť" "" :string) + ("û" "" :string) + ("ŭ" "" :string) + ("ů" "" :string) + ("ű" "" :string) + ("ù" "" :string) + ("Ŭ" "" :string) + ("Ù" "" :string) + ("Ű" "" :string) + ("Ü" "" :string) + ("Ů" "" :string) + ("ú" "" :string) + ("Ú" "" :string) + ("Û" "" :string) + ("ü" "" :string) + ("ÿ" "" :string) + ("Ý" "" :string) + ("Ÿ" "" :string) + ("ý" "" :string) + ("Ż" "" :string) + ("Ž" "" :string) + ("Ź" "" :string) + ("ž" "" :string) + ("ż" "" :string) + ("ź" "" :string) + ("a" "" :string) + ("A" "" :string) + ("b" "" :string) + ("B" "" :string) + ("c" "" :string) + ("C" "" :string) + ("d" "" :string) + ("D" "" :string) + ("e" "" :string) + ("E" "" :string) + ("F" "" :string) + ("f" "" :string) + ("G" "" :string) + ("g" "" :string) + ("H" "" :string) + ("h" "" :string) + ("i" "" :string) + ("I" "" :string) + ("J" "" :string) + ("j" "" :string) + ("K" "" :string) + ("k" "" :string) + ("L" "" :string) + ("l" "" :string) + ("M" "" :string) + ("m" "" :string) + ("n" "" :string) + ("N" "" :string) + ("O" "" :string) + ("o" "" :string) + ("p" "" :string) + ("P" "" :string) + ("Q" "" :string) + ("q" "" :string) + ("r" "" :string) + ("R" "" :string) + ("S" "" :string) + ("s" "" :string) + ("t" "" :string) + ("T" "" :string) + ("u" "" :string) + ("U" "" :string) + ("v" "" :string) + ("V" "" :string) + ("W" "" :string) + ("w" "" :string) + ("x" "" :string) + ("X" "" :string) + ("Y" "" :string) + ("y" "" :string) + ("z" "" :string) + ("Z" "" :string) + )) + +(define-rule-set "sphinx-xy-resolve-diacritics" + + :rules (("Ĥ" "" :string) + ("ó" "" :string) + ("ľ" "" :string) + ("Ř" "" :string) + ("ĝ" "" :string) + ("ď" "" :string) + ("Ě" "" :string) + ("ĥ" "" :string) + ("Č" "" :string) + ("Ĵ" "" :string) + ("ě" "" :string) + ("ž" "" :string) + ("Ď" "" :string) + ("ř" "" :string) + ("Ž" "" :string) + ("ı" "" :string) + ("Ť" "" :string) + ("á" "" :string) + ("č" "" :string) + ("Á" "" :string) + ("ň" "" :string) + ("Š" "" :string) + ("Ň" "" :string) + ("ĵ" "" :string) + ("ť" "" :string) + ("Ó" "" :string) + ("ý" "" :string) + ("Ĝ" "" :string) + ("Ú" "" :string) + ("Ľ" "" :string) + ("š" "" :string) + ("Ý" "" :string) + ("ú" "" :string) + ("Ś" "" :string) + ("ć" "" :string) + ("Ł" "" :string) + ("ł" "" :string) + ("ń" "" :string) + ("À" "" :string) + ("Ź" "" :string) + ("à" "" :string) + ("Ń" "" :string) + ("Đ" "" :string) + ("ÿ" "" :string) + ("ś" "" :string) + ("Ğ" "" :string) + ("ğ" "" :string) + ("Ù" "" :string) + ("İ" "" :string) + ("đ" "" :string) + ("ù" "" :string) + ("Ț" "" :string) + ("é" "" :string) + ("ŕ" "" :string) + ("Ć" "" :string) + ("ț" "" :string) + ("ò" "" :string) + ("ź" "" :string) + ("Ò" "" :string) + ("Ÿ" "" :string) + ("Ŕ" "" :string) + ("É" "" :string) + ("ĉ" "" :string) + ("ô" "" :string) + ("Í" "" :string) + ("ŝ" "" :string) + ("Ż" "" :string) + ("Ă" "" :string) + ("Ŝ" "" :string) + ("ñ" "" :string) + ("ŭ" "" :string) + ("í" "" :string) + ("È" "" :string) + ("Ô" "" :string) + ("Ŭ" "" :string) + ("ż" "" :string) + ("Ñ" "" :string) + ("è" "" :string) + ("Ĉ" "" :string) + ("ă" "" :string) + ("â" "" :string) + ("û" "" :string) + ("ê" "" :string) + ("Õ" "" :string) + ("õ" "" :string) + ("ș" "" :string) + ("ç" "" :string) + ("Â" "" :string) + ("Ê" "" :string) + ("Û" "" :string) + ("Ç" "" :string) + ("ì" "" :string) + ("Ì" "" :string) + ("Ș" "" :string) + ("ö" "" :string) + ("Ö" "" :string) + ("ş" "" :string) + ("ů" "" :string) + ("ë" "" :string) + ("ã" "" :string) + ("î" "" :string) + ("Î" "" :string) + ("Ã" "" :string) + ("Ş" "" :string) + ("Ů" "" :string) + ("Ë" "" :string) + ("ï" "" :string) + ("Ő" "" :string) + ("Ï" "" :string) + ("Ę" "" :string) + ("ő" "" :string) + ("Ü" "" :string) + ("Å" "" :string) + ("ü" "" :string) + ("ę" "" :string) + ("å" "" :string) + ("Ä" "" :string) + ("ű" "" :string) + ("Ø" "" :string) + ("ø" "" :string) + ("Ű" "" :string) + ("ä" "" :string) + ("Ą" "" :string) + ("ą" "" :string) + ("œ" "" :string) + ("ß" "" :string) + ("Æ" "" :string) + ("Œ" "" :string) + ("æ" "" :string) + ("e" "" :string) + ("t" "" :string) + ("L" "" :string) + ("Y" "" :string) + ("J" "" :string) + ("a" "" :string) + ("p" "" :string) + ("u" "" :string) + ("j" "" :string) + ("b" "" :string) + ("G" "" :string) + ("U" "" :string) + ("F" "" :string) + ("H" "" :string) + ("i" "" :string) + ("z" "" :string) + ("c" "" :string) + ("l" "" :string) + ("A" "" :string) + ("Q" "" :string) + ("w" "" :string) + ("D" "" :string) + ("R" "" :string) + ("d" "" :string) + ("s" "" :string) + ("r" "" :string) + ("k" "" :string) + ("v" "" :string) + ("m" "" :string) + ("P" "" :string) + ("y" "" :string) + ("K" "" :string) + ("q" "" :string) + ("S" "" :string) + ("I" "" :string) + ("C" "" :string) + ("M" "" :string) + ("Z" "" :string) + ("T" "" :string) + ("W" "" :string) + ("B" "" :string) + ("h" "" :string) + ("x" "" :string) + ("X" "" :string) + ("f" "" :string) + ("E" "" :string) + ("V" "" :string) + ("N" "" :string) + ("O" "" :string) + ("o" "" :string) + ("g" "" :string) + ("n" "" :string) + )) + +(define-rule-set "sphinx-xy-resolve-case" + + :rules (("Ú" "8" :string) + ("Ÿ" "8" :string) + ("Ç" "8" :string) + ("Ĉ" "8" :string) + ("Ŕ" "8" :string) + ("Ľ" "8" :string) + ("Ů" "8" :string) + ("Ý" "8" :string) + ("É" "8" :string) + ("Ë" "8" :string) + ("Ș" "8" :string) + ("Ì" "8" :string) + ("Ê" "8" :string) + ("Ň" "8" :string) + ("Ą" "8" :string) + ("Š" "8" :string) + ("Û" "8" :string) + ("Ş" "8" :string) + ("Ć" "8" :string) + ("Ò" "8" :string) + ("Ĝ" "8" :string) + ("Ñ" "8" :string) + ("Ó" "8" :string) + ("Î" "8" :string) + ("Á" "8" :string) + ("Ã" "8" :string) + ("Ț" "8" :string) + ("Å" "8" :string) + ("Ğ" "8" :string) + ("Ü" "8" :string) + ("È" "8" :string) + ("Ô" "8" :string) + ("İ" "8" :string) + ("Ű" "8" :string) + ("Ù" "8" :string) + ("Ŭ" "8" :string) + ("Â" "8" :string) + ("Ť" "8" :string) + ("Ń" "8" :string) + ("Ď" "8" :string) + ("Ź" "8" :string) + ("Ž" "8" :string) + ("Đ" "8" :string) + ("Ŝ" "8" :string) + ("Č" "8" :string) + ("Ĵ" "8" :string) + ("Ö" "8" :string) + ("Ø" "8" :string) + ("Ż" "8" :string) + ("Ł" "8" :string) + ("Ă" "8" :string) + ("Ě" "8" :string) + ("Ő" "8" :string) + ("Õ" "8" :string) + ("Ę" "8" :string) + ("Ï" "8" :string) + ("À" "8" :string) + ("Ĥ" "8" :string) + ("Ä" "8" :string) + ("Ś" "8" :string) + ("Ř" "8" :string) + ("Í" "8" :string) + ("Œ" "89" :string) + ("Æ" "89" :string) + ("ì" "9" :string) + ("è" "9" :string) + ("ą" "9" :string) + ("š" "9" :string) + ("ú" "9" :string) + ("å" "9" :string) + ("ă" "9" :string) + ("ę" "9" :string) + ("ü" "9" :string) + ("ź" "9" :string) + ("ò" "9" :string) + ("ť" "9" :string) + ("ț" "9" :string) + ("ĵ" "9" :string) + ("ŕ" "9" :string) + ("ż" "9" :string) + ("ä" "9" :string) + ("ý" "9" :string) + ("ù" "9" :string) + ("á" "9" :string) + ("é" "9" :string) + ("č" "9" :string) + ("ň" "9" :string) + ("ś" "9" :string) + ("ø" "9" :string) + ("í" "9" :string) + ("đ" "9" :string) + ("ı" "9" :string) + ("ğ" "9" :string) + ("î" "9" :string) + ("ã" "9" :string) + ("à" "9" :string) + ("ř" "9" :string) + ("ő" "9" :string) + ("ů" "9" :string) + ("ș" "9" :string) + ("ÿ" "9" :string) + ("ë" "9" :string) + ("ŭ" "9" :string) + ("ç" "9" :string) + ("ű" "9" :string) + ("ñ" "9" :string) + ("õ" "9" :string) + ("ě" "9" :string) + ("ş" "9" :string) + ("ž" "9" :string) + ("ĝ" "9" :string) + ("ŝ" "9" :string) + ("ń" "9" :string) + ("û" "9" :string) + ("ł" "9" :string) + ("ď" "9" :string) + ("ĥ" "9" :string) + ("ê" "9" :string) + ("ô" "9" :string) + ("ĉ" "9" :string) + ("â" "9" :string) + ("ć" "9" :string) + ("ï" "9" :string) + ("ö" "9" :string) + ("ľ" "9" :string) + ("ó" "9" :string) + ("æ" "99" :string) + ("ß" "99" :string) + ("œ" "99" :string) + ("N" "8" :string) + ("V" "8" :string) + ("O" "8" :string) + ("X" "8" :string) + ("E" "8" :string) + ("P" "8" :string) + ("K" "8" :string) + ("T" "8" :string) + ("Z" "8" :string) + ("M" "8" :string) + ("C" "8" :string) + ("I" "8" :string) + ("S" "8" :string) + ("B" "8" :string) + ("W" "8" :string) + ("D" "8" :string) + ("R" "8" :string) + ("H" "8" :string) + ("F" "8" :string) + ("Q" "8" :string) + ("A" "8" :string) + ("G" "8" :string) + ("U" "8" :string) + ("J" "8" :string) + ("Y" "8" :string) + ("L" "8" :string) + ("o" "9" :string) + ("n" "9" :string) + ("g" "9" :string) + ("x" "9" :string) + ("f" "9" :string) + ("y" "9" :string) + ("q" "9" :string) + ("h" "9" :string) + ("w" "9" :string) + ("s" "9" :string) + ("d" "9" :string) + ("v" "9" :string) + ("k" "9" :string) + ("r" "9" :string) + ("m" "9" :string) + ("z" "9" :string) + ("c" "9" :string) + ("i" "9" :string) + ("l" "9" :string) + ("b" "9" :string) + ("j" "9" :string) + ("a" "9" :string) + ("p" "9" :string) + ("u" "9" :string) + ("t" "9" :string) + ("e" "9" :string) + )) + +(use-rule-set :run 0 + :rule-set ("sphinx-xy-alphabetize")) +(use-rule-set :run 1 + :rule-set ("sphinx-xy-resolve-diacritics")) +(use-rule-set :run 2 + :rule-set ("sphinx-xy-resolve-case")) From d8b90fcd66407786bde26915d5dc705cad208020 Mon Sep 17 00:00:00 2001 From: jfbu Date: Sun, 22 Jul 2018 21:53:39 +0200 Subject: [PATCH 047/174] renamed: sphinx-isolatin.xdy -> LatinRules.xdy --- sphinx/texinputs/{sphinx-isolatin.xdy => LatinRules.xdy} | 5 +++-- sphinx/texinputs/Makefile_t | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) rename sphinx/texinputs/{sphinx-isolatin.xdy => LatinRules.xdy} (99%) diff --git a/sphinx/texinputs/sphinx-isolatin.xdy b/sphinx/texinputs/LatinRules.xdy similarity index 99% rename from sphinx/texinputs/sphinx-isolatin.xdy rename to sphinx/texinputs/LatinRules.xdy index 7757f9d99..99f14a2ee 100644 --- a/sphinx/texinputs/sphinx-isolatin.xdy +++ b/sphinx/texinputs/LatinRules.xdy @@ -1,5 +1,5 @@ ;; style file for xindy -;; filename: sphinx-isolatin.xdy +;; filename: LatinRules.xdy ;; ;; It is based upon xindy's files lang/general/utf8.xdy and ;; lang/general/utf8-lang.xdy which implement @@ -13,7 +13,8 @@ ;; observed not to use bytes with octal encoding 0o266 or higher. ;; ;; So here we use only 0o266 or higher bytes. -;; +;; (Ŋ, ŋ, IJ, and ij are absent from +;; lang/general/utf8.xdy and not included here) ;; Contributed by the Sphinx team, 2018. (define-letter-group "A" :prefixes ("")) diff --git a/sphinx/texinputs/Makefile_t b/sphinx/texinputs/Makefile_t index 0b715481a..782d5ef9a 100644 --- a/sphinx/texinputs/Makefile_t +++ b/sphinx/texinputs/Makefile_t @@ -31,7 +31,7 @@ XINDYOPTS += -M LICRcyr2utf8.xdy {% endif -%} {% endif -%} {% if xindy_cyrillic -%} -XINDYOPTS += -M sphinx-isolatin.xdy +XINDYOPTS += -M LatinRules.xdy {% endif -%} # also with pdflatex as LICRlatin2utf8.xdy replaces xindy's /tex/inputenc/utf8.xdy XINDYOPTS += -I xelatex From fcd0b78afa01c2bbf6672b463ad78736f9f3681b Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Tue, 24 Jul 2018 21:00:47 +0200 Subject: [PATCH 048/174] #5186 add JS test installer & runner --- .travis.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index f4a9d32af..2390d5c7a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,7 +7,7 @@ env: global: - PYTHONFAULTHANDLER=x - SKIP_LATEX_BUILD=1 - - RUN_TOX=true + - IS_PYTHON=true matrix: include: @@ -37,16 +37,18 @@ matrix: - language: node_js node_js: - 10.7 - env: RUN_TOX=false + env: IS_PYTHON=false before_script: - export DISPLAY=:99.0 - sh -e /etc/init.d/xvfb start install: - - if [ $RUN_TOX = true ]; then pip install -U tox codecov; fi + - if [ $IS_PYTHON = true ]; then pip install -U tox codecov; fi + - if [ $IS_PYTHON = false ]; then npm install; fi script: - - if [ $RUN_TOX = true ]; then tox -- -v; fi + - if [ $IS_PYTHON = true ]; then tox -- -v; fi + - if [ $IS_PYTHON = false ]; then npm test; fi after_success: - if [[ -e .coverage ]]; then codecov -e $TOXENV; fi From 01fea198d02f325d9c6046928ee9e0179678b8f9 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 28 Jul 2018 17:55:00 +0900 Subject: [PATCH 049/174] Fix setup_command uses deprecated module --- sphinx/setup_command.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index ca3256c19..733bc4e34 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -21,7 +21,7 @@ from distutils.errors import DistutilsOptionError, DistutilsExecError from six import StringIO, string_types from sphinx.application import Sphinx -from sphinx.cmdline import handle_exception +from sphinx.cmd.build import handle_exception from sphinx.util.console import nocolor, color_terminal from sphinx.util.docutils import docutils_namespace, patch_docutils from sphinx.util.osutil import abspath From dd65d00f2996419c82158818bee592cae869fc80 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 17 May 2018 00:57:09 +0900 Subject: [PATCH 050/174] Implement math_renderer framework --- CHANGES | 2 ++ doc/extdev/appapi.rst | 2 ++ doc/extdev/index.rst | 5 ++++ sphinx/application.py | 14 ++++++++++ sphinx/builders/html.py | 41 ++++++++++++++++++++++++++- sphinx/ext/imgmath.py | 11 ++++---- sphinx/ext/jsmath.py | 12 ++++---- sphinx/ext/mathbase.py | 17 ++++++------ sphinx/ext/mathjax.py | 12 ++++---- sphinx/registry.py | 15 ++++++++++ sphinx/writers/html.py | 28 +++++++++++++++---- sphinx/writers/html5.py | 28 +++++++++++++++---- tests/test_build_html.py | 60 ++++++++++++++++++++++++++++++++++++++++ 13 files changed, 210 insertions(+), 37 deletions(-) diff --git a/CHANGES b/CHANGES index d90f9ee88..b3e09e9ec 100644 --- a/CHANGES +++ b/CHANGES @@ -102,6 +102,7 @@ Deprecated * ``sphinx.ext.mathbase.eqref`` node is deprecated * ``sphinx.ext.mathbase.is_in_section_title()`` is deprecated * ``sphinx.ext.mathbase.MathDomain`` is deprecated +* ``sphinx.ext.mathbase.setup_math()`` is deprecated For more details, see `deprecation APIs list `_ @@ -163,6 +164,7 @@ Features added * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter * #5122: setuptools: support nitpicky option * #2820: autoclass directive supports nested class +* Add ``app.add_html_math_renderer()`` to register a math renderer for HTML Bugs fixed ---------- diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index 9828f035f..ee612765c 100644 --- a/doc/extdev/appapi.rst +++ b/doc/extdev/appapi.rst @@ -93,6 +93,8 @@ package. .. automethod:: Sphinx.add_html_theme(name, theme_path) +.. automethod:: Sphinx.add_html_math_renderer(name, inline_renderers, block_renderers) + .. automethod:: Sphinx.add_message_catalog(catalog, locale_dir) .. automethod:: Sphinx.is_parallel_allowed(typ) diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 7aa6a7948..d9971cf99 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -136,6 +136,11 @@ The following is a list of deprecated interface. - 3.0 - ``sphinx.domains.math.MathDomain`` + * - ``sphinx.ext.mathbase.setup_math()`` + - 1.8 + - 3.0 + - :meth:`~sphinx.application.Sphinx.add_html_math_renderer()` + * - ``sphinx.ext.mathbase.is_in_section_title()`` - 1.8 - 3.0 diff --git a/sphinx/application.py b/sphinx/application.py index 2bf40e115..18aba3016 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -1220,6 +1220,20 @@ class Sphinx(object): logger.debug('[app] adding HTML theme: %r, %r', name, theme_path) self.html_themes[name] = theme_path + def add_html_math_renderer(self, name, inline_renderers=None, block_renderers=None): + # type: (unicode, Tuple[Callable, Callable], Tuple[Callable, Callable]) -> None + """Register a math renderer for HTML. + + The *name* is a name of the math renderer. Both *inline_renderers* and + *block_renderes* are used as visitor functions for HTML writer. + *inline_renderers* is used for inline math node (``nodes.math`)). The + another is used for block math node (``nodes.math_block``). About + visitor functions, see :meth:`add_node` for more details. + + .. versionadded:: 1.8 + """ + self.registry.add_html_math_renderer(name, inline_renderers, block_renderers) + def add_message_catalog(self, catalog, locale_dir): # type: (unicode, unicode) -> None """Register a message catalog. diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index 16587fd18..b55aa9147 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -36,7 +36,7 @@ from sphinx.deprecation import RemovedInSphinx20Warning, RemovedInSphinx30Warnin from sphinx.environment.adapters.asset import ImageAdapter from sphinx.environment.adapters.indexentries import IndexEntries from sphinx.environment.adapters.toctree import TocTree -from sphinx.errors import ThemeError +from sphinx.errors import ConfigError, ThemeError from sphinx.highlighting import PygmentsBridge from sphinx.locale import _, __ from sphinx.search import js_index @@ -438,6 +438,27 @@ class StandaloneHTMLBuilder(Builder): else: return HTMLTranslator + @property + def math_renderer_name(self): + # type: () -> unicode + name = self.get_builder_config('math_renderer', 'html') + if name is not None: + # use given name + return name + else: + # not given: choose a math_renderer from registered ones as possible + renderers = list(self.app.registry.html_inline_math_renderers) + if len(renderers) == 1: + # only default math_renderer (mathjax) is registered + return renderers[0] + elif len(renderers) == 2: + # default and another math_renderer are registered; prior the another + renderers.remove('mathjax') + return renderers[0] + else: + # many math_renderers are registered. can't choose automatically! + return None + def get_outdated_docs(self): # type: () -> Iterator[unicode] try: @@ -1625,6 +1646,19 @@ def setup_js_tag_helper(app, pagename, templatexname, context, doctree): context['js_tag'] = js_tag +def validate_math_renderer(app): + # type: (Sphinx) -> None + if app.builder.format != 'html': + return + + name = app.builder.math_renderer_name # type: ignore + if name is None: + raise ConfigError(__('Many math_renderers are registered. ' + 'But no math_renderer is selected.')) + elif name not in app.registry.html_inline_math_renderers: + raise ConfigError(__('Unknown math_renderer %r is given.') % name) + + def setup(app): # type: (Sphinx) -> Dict[unicode, Any] # builders @@ -1674,12 +1708,17 @@ def setup(app): app.add_config_value('html_scaled_image_link', True, 'html') app.add_config_value('html_experimental_html5_writer', None, 'html') app.add_config_value('html_baseurl', '', 'html') + app.add_config_value('html_math_renderer', None, 'env') # event handlers app.connect('config-inited', convert_html_css_files) app.connect('config-inited', convert_html_js_files) + app.connect('builder-inited', validate_math_renderer) app.connect('html-page-context', setup_js_tag_helper) + # load default math renderer + app.setup_extension('sphinx.ext.mathjax') + return { 'version': 'builtin', 'parallel_read_safe': True, diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index 0cdc9aba4..eae577f2a 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -22,9 +22,9 @@ from docutils import nodes from six import text_type import sphinx -from sphinx.errors import SphinxError, ExtensionError +from sphinx.errors import SphinxError from sphinx.ext.mathbase import get_node_equation_number -from sphinx.ext.mathbase import setup_math as mathbase_setup, wrap_displaymath +from sphinx.ext.mathbase import wrap_displaymath from sphinx.locale import _, __ from sphinx.util import logging from sphinx.util.osutil import ensuredir, ENOENT, cd @@ -349,10 +349,9 @@ def html_visit_displaymath(self, node): def setup(app): # type: (Sphinx) -> Dict[unicode, Any] - try: - mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None)) - except ExtensionError: - raise ExtensionError('sphinx.ext.imgmath: other math package is already loaded') + app.add_html_math_renderer('imgmath', + (html_visit_math, None), + (html_visit_displaymath, None)) app.add_config_value('imgmath_image_format', 'png', 'html') app.add_config_value('imgmath_dvipng', 'dvipng', 'html') diff --git a/sphinx/ext/jsmath.py b/sphinx/ext/jsmath.py index 809ce0424..5dbb20fba 100644 --- a/sphinx/ext/jsmath.py +++ b/sphinx/ext/jsmath.py @@ -15,7 +15,6 @@ from docutils import nodes import sphinx from sphinx.errors import ExtensionError from sphinx.ext.mathbase import get_node_equation_number -from sphinx.ext.mathbase import setup_math as mathbase_setup from sphinx.locale import _ if False: @@ -61,7 +60,9 @@ def html_visit_displaymath(self, node): def builder_inited(app): # type: (Sphinx) -> None - if not app.config.jsmath_path: + if app.builder.format != 'html' or app.builder.math_renderer_name != 'jsmath': # type: ignore # NOQA + pass + elif not app.config.jsmath_path: raise ExtensionError('jsmath_path config value must be set for the ' 'jsmath extension to work') if app.builder.format == 'html': @@ -70,10 +71,9 @@ def builder_inited(app): def setup(app): # type: (Sphinx) -> Dict[unicode, Any] - try: - mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None)) - except ExtensionError: - raise ExtensionError('sphinx.ext.jsmath: other math package is already loaded') + app.add_html_math_renderer('jsmath', + (html_visit_math, None), + (html_visit_displaymath, None)) app.add_config_value('jsmath_path', '', False) app.connect('builder-inited', builder_inited) diff --git a/sphinx/ext/mathbase.py b/sphinx/ext/mathbase.py index 9ad07a12b..77cf43c8b 100644 --- a/sphinx/ext/mathbase.py +++ b/sphinx/ext/mathbase.py @@ -13,7 +13,7 @@ import warnings from docutils import nodes -from sphinx.addnodes import math, math_block as displaymath +from sphinx.addnodes import math, math_block as displaymath # NOQA # to keep compatibility from sphinx.builders.latex.nodes import math_reference as eqref # NOQA # to keep compatibility from sphinx.deprecation import RemovedInSphinx30Warning from sphinx.domains.math import MathDomain # NOQA # to keep compatibility @@ -44,7 +44,7 @@ def get_node_equation_number(writer, node): return number -def wrap_displaymath(math, label, numbering): +def wrap_displaymath(text, label, numbering): # type: (unicode, unicode, bool) -> unicode def is_equation(part): # type: (unicode) -> unicode @@ -56,7 +56,7 @@ def wrap_displaymath(math, label, numbering): labeldef = r'\label{%s}' % label numbering = True - parts = list(filter(is_equation, math.split('\n\n'))) + parts = list(filter(is_equation, text.split('\n\n'))) equations = [] if len(parts) == 0: return '' @@ -97,8 +97,9 @@ def is_in_section_title(node): def setup_math(app, htmlinlinevisitors, htmldisplayvisitors): - # type: (Sphinx, Tuple[Callable, Any], Tuple[Callable, Any]) -> None - app.add_node(math, override=True, - html=htmlinlinevisitors) - app.add_node(displaymath, override=True, - html=htmldisplayvisitors) + # type: (Sphinx, Tuple[Callable, Callable], Tuple[Callable, Callable]) -> None + warnings.warn('setup_math() is deprecated. ' + 'Please use app.add_html_math_renderer() instead.', + RemovedInSphinx30Warning) + + app.add_html_math_renderer('unknown', htmlinlinevisitors, htmldisplayvisitors) diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index 0d73f3d3d..20d5866c5 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -16,7 +16,6 @@ from docutils import nodes import sphinx from sphinx.errors import ExtensionError from sphinx.ext.mathbase import get_node_equation_number -from sphinx.ext.mathbase import setup_math as mathbase_setup from sphinx.locale import _ if False: @@ -69,7 +68,9 @@ def html_visit_displaymath(self, node): def builder_inited(app): # type: (Sphinx) -> None - if not app.config.mathjax_path: + if app.builder.format != 'html' or app.builder.math_renderer_name != 'mathjax': # type: ignore # NOQA + pass + elif not app.config.mathjax_path: raise ExtensionError('mathjax_path config value must be set for the ' 'mathjax extension to work') if app.builder.format == 'html': @@ -81,10 +82,9 @@ def builder_inited(app): def setup(app): # type: (Sphinx) -> Dict[unicode, Any] - try: - mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None)) - except ExtensionError: - raise ExtensionError('sphinx.ext.mathjax: other math package is already loaded') + app.add_html_math_renderer('mathjax', + (html_visit_math, None), + (html_visit_displaymath, None)) # more information for mathjax secure url is here: # https://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn diff --git a/sphinx/registry.py b/sphinx/registry.py index 2c73dbbd3..416edb2bc 100644 --- a/sphinx/registry.py +++ b/sphinx/registry.py @@ -92,6 +92,11 @@ class SphinxComponentRegistry(object): #: a dict of node class -> tuple of figtype and title_getter function self.enumerable_nodes = {} # type: Dict[nodes.Node, Tuple[unicode, TitleGetter]] + #: HTML inline and block math renderers + #: a dict of name -> tuple of visit function and depart function + self.html_inline_math_renderers = {} # type: Dict[unicode, Tuple[Callable, Callable]] # NOQA + self.html_block_math_renderers = {} # type: Dict[unicode, Tuple[Callable, Callable]] # NOQA + #: js_files; list of JS paths or URLs self.js_files = [] # type: List[Tuple[unicode, Dict[unicode, unicode]]] @@ -439,6 +444,16 @@ class SphinxComponentRegistry(object): raise ExtensionError(__('enumerable_node %r already registered') % node) self.enumerable_nodes[node] = (figtype, title_getter) + def add_html_math_renderer(self, name, inline_renderers, block_renderers): + # type: (unicode, Tuple[Callable, Callable], Tuple[Callable, Callable]) -> None + logger.debug('[app] adding html_math_renderer: %s, %r, %r', + name, inline_renderers, block_renderers) + if name in self.html_inline_math_renderers: + raise ExtensionError(__('math renderer %s is already registred') % name) + + self.html_inline_math_renderers[name] = inline_renderers + self.html_block_math_renderers[name] = block_renderers + def load_extension(self, app, extname): # type: (Sphinx, unicode) -> None """Load a Sphinx extension.""" diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index 0586636df..7724a05a8 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -874,11 +874,29 @@ class HTMLTranslator(BaseTranslator): def visit_math(self, node, math_env=''): # type: (nodes.Node, unicode) -> None - logger.warning(__('using "math" markup without a Sphinx math extension ' - 'active, please use one of the math extensions ' - 'described at http://sphinx-doc.org/en/master/ext/math.html'), - location=(self.builder.current_docname, node.line)) - raise nodes.SkipNode + name = self.builder.math_renderer_name + visit, _ = self.builder.app.registry.html_inline_math_renderers[name] + visit(self, node) + + def depart_math(self, node, math_env=''): + # type: (nodes.Node, unicode) -> None + name = self.builder.math_renderer_name + _, depart = self.builder.app.registry.html_inline_math_renderers[name] + if depart: + depart(self, node) + + def visit_math_block(self, node, math_env=''): + # type: (nodes.Node, unicode) -> None + name = self.builder.math_renderer_name + visit, _ = self.builder.app.registry.html_block_math_renderers[name] + visit(self, node) + + def depart_math_block(self, node, math_env=''): + # type: (nodes.Node, unicode) -> None + name = self.builder.math_renderer_name + _, depart = self.builder.app.registry.html_block_math_renderers[name] + if depart: + depart(self, node) def unknown_visit(self, node): # type: (nodes.Node) -> None diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 85a7ef7c2..aa496d19e 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -825,11 +825,29 @@ class HTML5Translator(BaseTranslator): def visit_math(self, node, math_env=''): # type: (nodes.Node, unicode) -> None - logger.warning(__('using "math" markup without a Sphinx math extension ' - 'active, please use one of the math extensions ' - 'described at http://sphinx-doc.org/en/master/ext/math.html'), - location=(self.builder.current_docname, node.line)) - raise nodes.SkipNode + name = self.builder.math_renderer_name + visit, _ = self.builder.app.registry.html_inline_math_renderers[name] + visit(self, node) + + def depart_math(self, node, math_env=''): + # type: (nodes.Node, unicode) -> None + name = self.builder.math_renderer_name + _, depart = self.builder.app.registry.html_inline_math_renderers[name] + if depart: + depart(self, node) + + def visit_math_block(self, node, math_env=''): + # type: (nodes.Node, unicode) -> None + name = self.builder.math_renderer_name + visit, _ = self.builder.app.registry.html_block_math_renderers[name] + visit(self, node) + + def depart_math_block(self, node, math_env=''): + # type: (nodes.Node, unicode) -> None + name = self.builder.math_renderer_name + _, depart = self.builder.app.registry.html_block_math_renderers[name] + if depart: + depart(self, node) def unknown_visit(self, node): # type: (nodes.Node) -> None diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 68017a80d..b8286edb3 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -18,6 +18,7 @@ import pytest from html5lib import getTreeBuilder, HTMLParser from six import PY3 +from sphinx.errors import ConfigError from sphinx.testing.util import remove_unicode_literals, strip_escseq from sphinx.util.inventory import InventoryFile @@ -1327,3 +1328,62 @@ def test_html_baseurl_and_html_file_suffix(app, status, warning): result = (app.outdir / 'qux' / 'index.htm').text(encoding='utf8') assert '' in result + + +@pytest.mark.sphinx('html', testroot='basic') +def test_default_html_math_renderer(app, status, warning): + assert app.builder.math_renderer_name == 'mathjax' + + +@pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinx.ext.mathjax']}) +def test_html_math_renderer_is_mathjax(app, status, warning): + assert app.builder.math_renderer_name == 'mathjax' + + +@pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinx.ext.imgmath']}) +def test_html_math_renderer_is_imgmath(app, status, warning): + assert app.builder.math_renderer_name == 'imgmath' + + +@pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinx.ext.jsmath', + 'sphinx.ext.imgmath']}) +def test_html_math_renderer_is_duplicated(make_app, app_params): + try: + args, kwargs = app_params + make_app(*args, **kwargs) + assert False + except ConfigError as exc: + assert str(exc) == ('Many math_renderers are registered. ' + 'But no math_renderer is selected.') + + +@pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinx.ext.imgmath', + 'sphinx.ext.mathjax']}) +def test_html_math_renderer_is_duplicated2(app, status, warning): + # case of both mathjax and another math_renderer is loaded + assert app.builder.math_renderer_name == 'imgmath' # The another one is chosen + + +@pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinx.ext.jsmath', + 'sphinx.ext.imgmath'], + 'html_math_renderer': 'imgmath'}) +def test_html_math_renderer_is_chosen(app, status, warning): + assert app.builder.math_renderer_name == 'imgmath' + + +@pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinx.ext.jsmath', + 'sphinx.ext.mathjax'], + 'html_math_renderer': 'imgmath'}) +def test_html_math_renderer_is_mismatched(make_app, app_params): + try: + args, kwargs = app_params + make_app(*args, **kwargs) + assert False + except ConfigError as exc: + assert str(exc) == "Unknown math_renderer 'imgmath' is given." From 7dad01d18f1f10906e376428e18a13d3371f8719 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 20 Jun 2018 19:27:38 +0900 Subject: [PATCH 051/174] test: Add do_autodoc() helper --- tests/test_autodoc.py | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index a42210a4c..2f08c5a4e 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -18,14 +18,24 @@ from docutils.statemachine import ViewList from six import PY3 from sphinx.ext.autodoc import ( - AutoDirective, ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL + AutoDirective, ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL, Options ) +from sphinx.ext.autodoc.directive import DocumenterBridge from sphinx.testing.util import SphinxTestApp, Struct # NOQA from sphinx.util import logging +from sphinx.util.docutils import LoggingReporter app = None +def do_autodoc(app, objtype, name, options={}): + bridge = DocumenterBridge(app.env, LoggingReporter(''), Options(options), 1) + documenter = app.registry.documenters[objtype](bridge, name) + documenter.generate() + + return bridge.result + + @pytest.fixture(scope='module', autouse=True) def setup_module(rootdir, sphinx_test_tempdir): try: @@ -917,17 +927,8 @@ def test_generate(): @pytest.mark.skipif(sys.version_info < (3, 4), reason='functools.partialmethod is available on py34 or above') -@pytest.mark.usefixtures('setup_test') -def test_partialmethod(): - def call_autodoc(objtype, name): - inst = app.registry.documenters[objtype](directive, name) - inst.generate() - result = list(directive.result) - del directive.result[:] - return result - - options.inherited_members = True - options.undoc_members = True +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_partialmethod(app): expected = [ '', '.. py:class:: Cell', @@ -962,4 +963,6 @@ def test_partialmethod(): # TODO: this condition should be updated after 3.7-final release. expected = '\n'.join(expected).replace(' -> None', '').split('\n') - assert call_autodoc('class', 'target.partialmethod.Cell') == expected + options = {"members": ALL} + actual = do_autodoc(app, 'class', 'target.partialmethod.Cell', options) + assert list(actual) == expected From e045dacc84b0246fc5a5b899fd4186e2cd8ff984 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 18 Jun 2018 12:58:32 +0900 Subject: [PATCH 052/174] doc: Move description for math confval, directives and roles to usage --- doc/usage/configuration.rst | 36 +++++++ doc/usage/extensions/math.rst | 118 ++-------------------- doc/usage/restructuredtext/directives.rst | 58 ++++++++++- doc/usage/restructuredtext/roles.rst | 20 ++++ 4 files changed, 119 insertions(+), 113 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index dd6fcfaef..bc1e3ce13 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -773,6 +773,35 @@ documentation on :ref:`intl` for details. Added ``{path}`` and ``{basename}`` tokens. +.. _math-options: + +Options for Math +---------------- + +These options influence Math notations. + +.. confval:: math_number_all + + Set this option to ``True`` if you want all displayed math to be numbered. + The default is ``False``. + +.. confval:: math_eqref_format + + A string that are used for format of label of references to equations. + As a special character, ``{number}`` will be replaced to equaition number. + + Example: ``'Eq.{number}'`` is rendered as ``Eq.10`` + +.. confval:: math_numfig + + If ``True``, displayed math equations are numbered across pages when + :confval:`numfig` is enabled. The :confval:`numfig_secnum_depth` setting + is respected. The :rst:role:`eq`, not :rst:role:`numref`, role + must be used to reference equation numbers. Default is ``True``. + + .. versionadded:: 1.7 + + .. _html-options: Options for HTML output @@ -1290,6 +1319,13 @@ that use Sphinx's HTMLWriter class. .. versionadded:: 1.3 +.. confval:: html_math_renderer + + The name of math_renderer extension for HTML output. The default is + ``'mathjax'``. + + .. versionadded:: 1.8 + .. confval:: html_experimental_html5_writer Output is processed with HTML5 writer. This feature needs docutils 0.13 or diff --git a/doc/usage/extensions/math.rst b/doc/usage/extensions/math.rst index c299b7bee..35f283846 100644 --- a/doc/usage/extensions/math.rst +++ b/doc/usage/extensions/math.rst @@ -2,123 +2,20 @@ .. _math-support: -Math support in Sphinx -====================== +Math support for HTML outputs in Sphinx +======================================= .. module:: sphinx.ext.mathbase :synopsis: Common math support for imgmath and mathjax / jsmath. .. versionadded:: 0.5 +.. versionchanged:: 1.8 + + Math support for non-HTML builders is integrated to sphinx-core. + So mathbase extension is no longer needed. Since mathematical notation isn't natively supported by HTML in any way, Sphinx -supports math in documentation with several extensions. - -The basic math support is contained in :mod:`sphinx.ext.mathbase`. Other math -support extensions should, if possible, reuse that support too. - -.. note:: - - :mod:`.mathbase` is not meant to be added to the :confval:`extensions` config - value, instead, use either :mod:`sphinx.ext.imgmath` or - :mod:`sphinx.ext.mathjax` as described below. - -The input language for mathematics is LaTeX markup. This is the de-facto -standard for plain-text math notation and has the added advantage that no -further translation is necessary when building LaTeX output. - -Keep in mind that when you put math markup in **Python docstrings** read by -:mod:`autodoc `, you either have to double all backslashes, -or use Python raw strings (``r"raw"``). - -:mod:`.mathbase` provides the following config values: - -.. confval:: math_number_all - - Set this option to ``True`` if you want all displayed math to be numbered. - The default is ``False``. - -.. confval:: math_eqref_format - - A string that are used for format of label of references to equations. - As a special character, ``{number}`` will be replaced to equaition number. - - Example: ``'Eq.{number}'`` is rendered as ``Eq.10`` - -.. confval:: math_numfig - - If ``True``, displayed math equations are numbered across pages when - :confval:`numfig` is enabled. The :confval:`numfig_secnum_depth` setting - is respected. The :rst:role:`eq`, not :rst:role:`numref`, role - must be used to reference equation numbers. Default is ``True``. - - .. versionadded:: 1.7 - -:mod:`.mathbase` defines these new markup elements: - -.. rst:role:: math - - Role for inline math. Use like this:: - - Since Pythagoras, we know that :math:`a^2 + b^2 = c^2`. - -.. rst:directive:: math - - Directive for displayed math (math that takes the whole line for itself). - - The directive supports multiple equations, which should be separated by a - blank line:: - - .. math:: - - (a + b)^2 = a^2 + 2ab + b^2 - - (a - b)^2 = a^2 - 2ab + b^2 - - In addition, each single equation is set within a ``split`` environment, - which means that you can have multiple aligned lines in an equation, - aligned at ``&`` and separated by ``\\``:: - - .. math:: - - (a + b)^2 &= (a + b)(a + b) \\ - &= a^2 + 2ab + b^2 - - For more details, look into the documentation of the `AmSMath LaTeX - package`_. - - When the math is only one line of text, it can also be given as a directive - argument:: - - .. math:: (a + b)^2 = a^2 + 2ab + b^2 - - Normally, equations are not numbered. If you want your equation to get a - number, use the ``label`` option. When given, it selects an internal label - for the equation, by which it can be cross-referenced, and causes an equation - number to be issued. See :rst:role:`eq` for an example. The numbering - style depends on the output format. - - There is also an option ``nowrap`` that prevents any wrapping of the given - math in a math environment. When you give this option, you must make sure - yourself that the math is properly set up. For example:: - - .. math:: - :nowrap: - - \begin{eqnarray} - y & = & ax^2 + bx + c \\ - f(x) & = & x^2 + 2xy + y^2 - \end{eqnarray} - -.. rst:role:: eq - - Role for cross-referencing equations via their label. Example:: - - .. math:: e^{i\pi} + 1 = 0 - :label: euler - - Euler's identity, equation :eq:`euler`, was elected one of the most - beautiful mathematical formulas. - +gives a math support to HTML document with several extensions. :mod:`sphinx.ext.imgmath` -- Render math as images -------------------------------------------------- @@ -299,4 +196,3 @@ package jsMath_. It provides this config value: .. _MathJax: https://www.mathjax.org/ .. _jsMath: http://www.math.union.edu/~dpvc/jsmath/ .. _preview-latex package: https://www.gnu.org/software/auctex/preview-latex.html -.. _AmSMath LaTeX package: https://www.ams.org/publications/authors/tex/amslatex diff --git a/doc/usage/restructuredtext/directives.rst b/doc/usage/restructuredtext/directives.rst index f03e12c4d..5678c82f4 100644 --- a/doc/usage/restructuredtext/directives.rst +++ b/doc/usage/restructuredtext/directives.rst @@ -1005,9 +1005,63 @@ this reason, the following directive exists: Math ---- -.. todo:: Move this in here. +The input language for mathematics is LaTeX markup. This is the de-facto +standard for plain-text math notation and has the added advantage that no +further translation is necessary when building LaTeX output. -See :ref:`math-support`. +Keep in mind that when you put math markup in **Python docstrings** read by +:mod:`autodoc `, you either have to double all backslashes, +or use Python raw strings (``r"raw"``). + +.. rst:directive:: math + + Directive for displayed math (math that takes the whole line for itself). + + The directive supports multiple equations, which should be separated by a + blank line:: + + .. math:: + + (a + b)^2 = a^2 + 2ab + b^2 + + (a - b)^2 = a^2 - 2ab + b^2 + + In addition, each single equation is set within a ``split`` environment, + which means that you can have multiple aligned lines in an equation, + aligned at ``&`` and separated by ``\\``:: + + .. math:: + + (a + b)^2 &= (a + b)(a + b) \\ + &= a^2 + 2ab + b^2 + + For more details, look into the documentation of the `AmSMath LaTeX + package`_. + + When the math is only one line of text, it can also be given as a directive + argument:: + + .. math:: (a + b)^2 = a^2 + 2ab + b^2 + + Normally, equations are not numbered. If you want your equation to get a + number, use the ``label`` option. When given, it selects an internal label + for the equation, by which it can be cross-referenced, and causes an equation + number to be issued. See :rst:role:`eq` for an example. The numbering + style depends on the output format. + + There is also an option ``nowrap`` that prevents any wrapping of the given + math in a math environment. When you give this option, you must make sure + yourself that the math is properly set up. For example:: + + .. math:: + :nowrap: + + \begin{eqnarray} + y & = & ax^2 + bx + c \\ + f(x) & = & x^2 + 2xy + y^2 + \end{eqnarray} + +.. _AmSMath LaTeX package: https://www.ams.org/publications/authors/tex/amslatex Grammar production displays diff --git a/doc/usage/restructuredtext/roles.rst b/doc/usage/restructuredtext/roles.rst index 882647d07..6e819aa68 100644 --- a/doc/usage/restructuredtext/roles.rst +++ b/doc/usage/restructuredtext/roles.rst @@ -277,6 +277,26 @@ The following role creates a cross-reference to a term in a during build. +Math +---- + +.. rst:role:: math + + Role for inline math. Use like this:: + + Since Pythagoras, we know that :math:`a^2 + b^2 = c^2`. + +.. rst:role:: eq + + Role for cross-referencing equations via their label. Example:: + + .. math:: e^{i\pi} + 1 = 0 + :label: euler + + Euler's identity, equation :eq:`euler`, was elected one of the most + beautiful mathematical formulas. + + Other semantic markup --------------------- From c657f1c1c2c673b39aa1ac3ca2e44e36d4bbbcaa Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 20 Jun 2018 20:00:17 +0900 Subject: [PATCH 053/174] test: Validate whole of generated docs by autodoc --- tests/test_autodoc.py | 669 +++++++++++++++++++++++++++++++++--------- 1 file changed, 526 insertions(+), 143 deletions(-) diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 2f08c5a4e..3c125cb96 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -10,6 +10,7 @@ :license: BSD, see LICENSE for details. """ +import re import sys from warnings import catch_warnings @@ -766,163 +767,545 @@ def test_generate(): assert_result_contains('.. py:class:: Class(arg)', 'module', 'target') assert_result_contains('.. py:exception:: CustomEx', 'module', 'target') - # test noindex flag - options.members = [] - options.noindex = True - assert_result_contains(' :noindex:', 'module', 'target') - assert_result_contains(' :noindex:', 'class', 'Base') - # okay, now let's get serious about mixing Python and C signature stuff - assert_result_contains('.. py:class:: CustomDict', 'class', 'CustomDict', - all_members=True) +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_noindex(app): + options = {"members": [], + "noindex": True} + actual = do_autodoc(app, 'module', 'target', options) + assert list(actual) == [ + '', + '.. py:module:: target', + ' :noindex:', + '' + ] - # test inner class handling - assert_processes([('class', 'target.Outer'), - ('class', 'target.Outer.Inner'), - ('method', 'target.Outer.Inner.meth')], - 'class', 'Outer', all_members=True) - assert_processes([('class', 'target.Outer.Inner'), - ('method', 'target.Outer.Inner.meth')], - 'class', 'target.Outer.Inner', all_members=True) + # TODO: :noindex: should be propagated to children of target item. - # test descriptor docstrings - assert_result_contains(' Descriptor instance docstring.', - 'attribute', 'target.Class.descr') + actual = do_autodoc(app, 'class', 'target.Base', options) + assert list(actual) == [ + '', + '.. py:class:: Base', + ' :noindex:', + ' :module: target', + '' + ] - # test generation for C modules (which have no source file) - directive.env.ref_context['py:module'] = 'time' - assert_processes([('function', 'time.asctime')], 'function', 'asctime') - assert_processes([('function', 'time.asctime')], 'function', 'asctime') - # test autodoc_member_order == 'source' - directive.env.ref_context['py:module'] = 'target' - options.private_members = True +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_subclass_of_builtin_class(app): + options = {"members": ALL} + actual = do_autodoc(app, 'class', 'target.CustomDict', options) + assert list(actual) == [ + '', + '.. py:class:: CustomDict', + ' :module: target', + '', + ' Docstring.', + ' ' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_inner_class(app): if PY3: - roger_line = ' .. py:classmethod:: Class.roger(a, *, b=2, c=3, d=4, e=5, f=6)' + builtins = ' alias of :class:`builtins.dict`' else: - roger_line = ' .. py:classmethod:: Class.roger(a, e=5, f=6)' - assert_order(['.. py:class:: Class(arg)', - ' .. py:attribute:: Class.descr', - ' .. py:method:: Class.meth()', - ' .. py:method:: Class.undocmeth()', - ' .. py:attribute:: Class.attr', - ' .. py:attribute:: Class.prop', - ' .. py:attribute:: Class.docattr', - ' .. py:attribute:: Class.udocattr', - ' .. py:attribute:: Class.mdocattr', - roger_line, - ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', - ' .. py:attribute:: Class.inst_attr_comment', - ' .. py:attribute:: Class.inst_attr_string', - ' .. py:attribute:: Class._private_inst_attr', - ' .. py:classmethod:: Class.inheritedclassmeth()', - ' .. py:method:: Class.inheritedmeth()', - ' .. py:staticmethod:: Class.inheritedstaticmeth(cls)', - ], - 'class', 'Class', member_order='bysource', all_members=True) - del directive.env.ref_context['py:module'] + builtins = ' alias of :class:`__builtin__.dict`' - # test attribute initialized to class instance from other module - directive.env.temp_data['autodoc:class'] = 'target.Class' - assert_result_contains(u' should be documented as well - s\xfc\xdf', - 'attribute', 'mdocattr') - del directive.env.temp_data['autodoc:class'] + options = {"members": ALL} + actual = do_autodoc(app, 'class', 'target.Outer', options) + assert list(actual) == [ + '', + '.. py:class:: Outer', + ' :module: target', + '', + ' Foo', + ' ', + ' ', + ' .. py:class:: Outer.Inner', + ' :module: target', + ' ', + ' Foo', + ' ', + ' ', + ' .. py:method:: Outer.Inner.meth()', + ' :module: target', + ' ', + ' Foo', + ' ', + ' ', + ' .. py:attribute:: Outer.factory', + ' :module: target', + ' ', + builtins + ] - # test autodoc_docstring_signature - assert_result_contains( - '.. py:method:: DocstringSig.meth(FOO, BAR=1) -> BAZ', 'method', - 'target.DocstringSig.meth') - assert_result_contains( - ' rest of docstring', 'method', 'target.DocstringSig.meth') - assert_result_contains( - '.. py:method:: DocstringSig.meth2()', 'method', - 'target.DocstringSig.meth2') - assert_result_contains( - ' indented line', 'method', - 'target.DocstringSig.meth2') - assert_result_contains( - '.. py:classmethod:: Class.moore(a, e, f) -> happiness', 'method', - 'target.Class.moore') + actual = do_autodoc(app, 'class', 'target.Outer.Inner', options) + assert list(actual) == [ + '', + '.. py:class:: Inner', + ' :module: target.Outer', + '', + ' Foo', + ' ', + ' ', + ' .. py:method:: Inner.meth()', + ' :module: target.Outer', + ' ', + ' Foo', + ' ', + ] - # test new attribute documenter behavior - directive.env.ref_context['py:module'] = 'target' - options.undoc_members = True - assert_processes([('class', 'target.AttCls'), - ('attribute', 'target.AttCls.a1'), - ('attribute', 'target.AttCls.a2'), - ], 'class', 'AttCls') - assert_result_contains( - ' :annotation: = hello world', 'attribute', 'AttCls.a1') - assert_result_contains( - ' :annotation: = None', 'attribute', 'AttCls.a2') - # test explicit members with instance attributes - del directive.env.temp_data['autodoc:class'] - del directive.env.temp_data['autodoc:module'] - directive.env.ref_context['py:module'] = 'target' - options.inherited_members = False - options.undoc_members = False - options.members = ALL - assert_processes([ - ('class', 'target.InstAttCls'), - ('attribute', 'target.InstAttCls.ca1'), - ('attribute', 'target.InstAttCls.ca2'), - ('attribute', 'target.InstAttCls.ca3'), - ('attribute', 'target.InstAttCls.ia1'), - ('attribute', 'target.InstAttCls.ia2'), - ], 'class', 'InstAttCls') - del directive.env.temp_data['autodoc:class'] - del directive.env.temp_data['autodoc:module'] - options.members = ['ca1', 'ia1'] - assert_processes([ - ('class', 'target.InstAttCls'), - ('attribute', 'target.InstAttCls.ca1'), - ('attribute', 'target.InstAttCls.ia1'), - ], 'class', 'InstAttCls') - del directive.env.temp_data['autodoc:class'] - del directive.env.temp_data['autodoc:module'] - del directive.env.ref_context['py:module'] +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_descriptor(app): + actual = do_autodoc(app, 'attribute', 'target.Class.descr') + assert list(actual) == [ + '', + '.. py:attribute:: Class.descr', + ' :module: target', + '', + ' Descriptor instance docstring.', + ' ' + ] - # test members with enum attributes - directive.env.ref_context['py:module'] = 'target' - options.inherited_members = False - options.undoc_members = True - options.members = ALL - assert_processes([ - ('class', 'target.EnumCls'), - ('attribute', 'target.EnumCls.val1'), - ('attribute', 'target.EnumCls.val2'), - ('attribute', 'target.EnumCls.val3'), - ('attribute', 'target.EnumCls.val4'), - ], 'class', 'EnumCls') - assert_result_contains( - ' :annotation: = 12', 'attribute', 'EnumCls.val1') - assert_result_contains( - ' :annotation: = 23', 'attribute', 'EnumCls.val2') - assert_result_contains( - ' :annotation: = 34', 'attribute', 'EnumCls.val3') - del directive.env.temp_data['autodoc:class'] - del directive.env.temp_data['autodoc:module'] - # test descriptor class documentation - options.members = ['CustomDataDescriptor', 'CustomDataDescriptor2'] - assert_result_contains('.. py:class:: CustomDataDescriptor(doc)', - 'module', 'target') - assert_result_contains(' .. py:method:: CustomDataDescriptor.meth()', - 'module', 'target') - assert_result_contains('.. py:class:: CustomDataDescriptor2(doc)', - 'module', 'target') +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_c_module(app): + actual = do_autodoc(app, 'function', 'time.asctime') + assert list(actual) == [ + '', + '.. py:function:: asctime([tuple]) -> string', + ' :module: time', + '', + " Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.", + ' When the time tuple is not present, current time as returned by localtime()', + ' is used.', + ' ' + ] - # test mocked module imports - options.members = ['TestAutodoc'] - options.undoc_members = False - assert_result_contains('.. py:class:: TestAutodoc', - 'module', 'autodoc_missing_imports') - assert_result_contains(' .. py:method:: TestAutodoc.decoratedMethod()', - 'module', 'autodoc_missing_imports') - options.members = ['decoratedFunction'] - assert_result_contains('.. py:function:: decoratedFunction()', - 'module', 'autodoc_missing_imports') + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_member_order(app): + if PY3: + roger_method = ' .. py:classmethod:: Class.roger(a, *, b=2, c=3, d=4, e=5, f=6)' + else: + roger_method = ' .. py:classmethod:: Class.roger(a, e=5, f=6)' + + # case member-order='bysource' + options = {"members": ALL, + 'member-order': 'bysource', + "undoc-members": True, + 'private-members': True} + actual = do_autodoc(app, 'class', 'target.Class', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Class(arg)', + ' .. py:attribute:: Class.descr', + ' .. py:method:: Class.meth()', + ' .. py:method:: Class.undocmeth()', + ' .. py:method:: Class.skipmeth()', + ' .. py:method:: Class.excludemeth()', + ' .. py:attribute:: Class.skipattr', + ' .. py:attribute:: Class.attr', + ' .. py:attribute:: Class.prop', + ' .. py:attribute:: Class.docattr', + ' .. py:attribute:: Class.udocattr', + ' .. py:attribute:: Class.mdocattr', + roger_method, + ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', + ' .. py:attribute:: Class.inst_attr_inline', + ' .. py:attribute:: Class.inst_attr_comment', + ' .. py:attribute:: Class.inst_attr_string', + ' .. py:attribute:: Class._private_inst_attr' + ] + + # case member-order='groupwise' + options = {"members": ALL, + 'member-order': 'groupwise', + "undoc-members": True, + 'private-members': True} + actual = do_autodoc(app, 'class', 'target.Class', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Class(arg)', + ' .. py:method:: Class.excludemeth()', + ' .. py:method:: Class.meth()', + ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', + roger_method, + ' .. py:method:: Class.skipmeth()', + ' .. py:method:: Class.undocmeth()', + ' .. py:attribute:: Class._private_inst_attr', + ' .. py:attribute:: Class.attr', + ' .. py:attribute:: Class.descr', + ' .. py:attribute:: Class.docattr', + ' .. py:attribute:: Class.inst_attr_comment', + ' .. py:attribute:: Class.inst_attr_inline', + ' .. py:attribute:: Class.inst_attr_string', + ' .. py:attribute:: Class.mdocattr', + ' .. py:attribute:: Class.prop', + ' .. py:attribute:: Class.skipattr', + ' .. py:attribute:: Class.udocattr' + ] + + # case member-order=None + options = {"members": ALL, + "undoc-members": True, + 'private-members': True} + actual = do_autodoc(app, 'class', 'target.Class', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Class(arg)', + ' .. py:attribute:: Class._private_inst_attr', + ' .. py:attribute:: Class.attr', + ' .. py:attribute:: Class.descr', + ' .. py:attribute:: Class.docattr', + ' .. py:method:: Class.excludemeth()', + ' .. py:attribute:: Class.inst_attr_comment', + ' .. py:attribute:: Class.inst_attr_inline', + ' .. py:attribute:: Class.inst_attr_string', + ' .. py:attribute:: Class.mdocattr', + ' .. py:method:: Class.meth()', + ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', + ' .. py:attribute:: Class.prop', + roger_method, + ' .. py:attribute:: Class.skipattr', + ' .. py:method:: Class.skipmeth()', + ' .. py:attribute:: Class.udocattr', + ' .. py:method:: Class.undocmeth()' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_module_scope(app): + def convert(s): + return re.sub('<.*>', '', s) # for py2/py3 + + app.env.temp_data['autodoc:module'] = 'target' + actual = do_autodoc(app, 'attribute', 'Class.mdocattr') + assert list(map(convert, actual)) == [ + u'', + u'.. py:attribute:: Class.mdocattr', + u' :module: target', + u' :annotation: = ', + u'', + u' should be documented as well - süß', + u' ' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_class_scope(app): + def convert(s): + return re.sub('<.*>', '', s) # for py2/py3 + + app.env.temp_data['autodoc:module'] = 'target' + app.env.temp_data['autodoc:class'] = 'Class' + actual = do_autodoc(app, 'attribute', 'mdocattr') + assert list(map(convert, actual)) == [ + u'', + u'.. py:attribute:: Class.mdocattr', + u' :module: target', + u' :annotation: = ', + u'', + u' should be documented as well - süß', + u' ' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_docstring_signature(app): + options = {"members": ALL} + actual = do_autodoc(app, 'class', 'target.DocstringSig', options) + assert list(actual) == [ + '', + '.. py:class:: DocstringSig', + ' :module: target', + '', + ' ', + ' .. py:method:: DocstringSig.meth(FOO, BAR=1) -> BAZ', + ' :module: target', + ' ', + ' First line of docstring', + ' ', + ' rest of docstring', + ' ', + ' ', + ' .. py:method:: DocstringSig.meth2()', + ' :module: target', + ' ', + ' First line, no signature', + ' Second line followed by indentation::', + ' ', + ' indented line', + ' ', + ' ', + ' .. py:attribute:: DocstringSig.prop1', + ' :module: target', + ' ', + ' First line of docstring', + ' ', + ' ', + ' .. py:attribute:: DocstringSig.prop2', + ' :module: target', + ' ', + ' First line of docstring', + ' Second line of docstring', + ' ' + ] + + # disable autodoc_docstring_signature + app.config.autodoc_docstring_signature = False + actual = do_autodoc(app, 'class', 'target.DocstringSig', options) + assert list(actual) == [ + u'', + u'.. py:class:: DocstringSig', + u' :module: target', + u'', + u' ', + u' .. py:method:: DocstringSig.meth()', + u' :module: target', + u' ', + u' meth(FOO, BAR=1) -> BAZ', + u' First line of docstring', + u' ', + u' rest of docstring', + u' ', + u' ', + u' ', + u' .. py:method:: DocstringSig.meth2()', + u' :module: target', + u' ', + u' First line, no signature', + u' Second line followed by indentation::', + u' ', + u' indented line', + u' ', + u' ', + u' .. py:attribute:: DocstringSig.prop1', + u' :module: target', + u' ', + u' DocstringSig.prop1(self)', + u' First line of docstring', + u' ', + u' ', + u' .. py:attribute:: DocstringSig.prop2', + u' :module: target', + u' ', + u' First line of docstring', + u' Second line of docstring', + u' ' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_class_attributes(app): + options = {"members": ALL, + "undoc-members": True} + actual = do_autodoc(app, 'class', 'target.AttCls', options) + assert list(actual) == [ + '', + '.. py:class:: AttCls', + ' :module: target', + '', + ' ', + ' .. py:attribute:: AttCls.a1', + ' :module: target', + ' :annotation: = hello world', + ' ', + ' ', + ' .. py:attribute:: AttCls.a2', + ' :module: target', + ' :annotation: = None', + ' ' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_instance_attributes(app): + options = {"members": ALL} + actual = do_autodoc(app, 'class', 'target.InstAttCls', options) + assert list(actual) == [ + '', + '.. py:class:: InstAttCls()', + ' :module: target', + '', + ' Class with documented class and instance attributes.', + ' ', + ' ', + ' .. py:attribute:: InstAttCls.ca1', + ' :module: target', + " :annotation: = 'a'", + ' ', + ' Doc comment for class attribute InstAttCls.ca1.', + ' It can have multiple lines.', + ' ', + ' ', + ' .. py:attribute:: InstAttCls.ca2', + ' :module: target', + " :annotation: = 'b'", + ' ', + ' Doc comment for InstAttCls.ca2. One line only.', + ' ', + ' ', + ' .. py:attribute:: InstAttCls.ca3', + ' :module: target', + " :annotation: = 'c'", + ' ', + ' Docstring for class attribute InstAttCls.ca3.', + ' ', + ' ', + ' .. py:attribute:: InstAttCls.ia1', + ' :module: target', + ' :annotation: = None', + ' ', + ' Doc comment for instance attribute InstAttCls.ia1', + ' ', + ' ', + ' .. py:attribute:: InstAttCls.ia2', + ' :module: target', + ' :annotation: = None', + ' ', + ' Docstring for instance attribute InstAttCls.ia2.', + ' ' + ] + + # pick up arbitrary attributes + options = {"members": ['ca1', 'ia1']} + actual = do_autodoc(app, 'class', 'target.InstAttCls', options) + assert list(actual) == [ + '', + '.. py:class:: InstAttCls()', + ' :module: target', + '', + ' Class with documented class and instance attributes.', + ' ', + ' ', + ' .. py:attribute:: InstAttCls.ca1', + ' :module: target', + " :annotation: = 'a'", + ' ', + ' Doc comment for class attribute InstAttCls.ca1.', + ' It can have multiple lines.', + ' ', + ' ', + ' .. py:attribute:: InstAttCls.ia1', + ' :module: target', + ' :annotation: = None', + ' ', + ' Doc comment for instance attribute InstAttCls.ia1', + ' ' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_enum_class(app): + options = {"members": ALL, + "undoc-members": True} + actual = do_autodoc(app, 'class', 'target.EnumCls', options) + assert list(actual) == [ + '', + '.. py:class:: EnumCls', + ' :module: target', + '', + ' this is enum class', + ' ', + ' ', + ' .. py:attribute:: EnumCls.val1', + ' :module: target', + ' :annotation: = 12', + ' ', + ' doc for val1', + ' ', + ' ', + ' .. py:attribute:: EnumCls.val2', + ' :module: target', + ' :annotation: = 23', + ' ', + ' doc for val2', + ' ', + ' ', + ' .. py:attribute:: EnumCls.val3', + ' :module: target', + ' :annotation: = 34', + ' ', + ' doc for val3', + ' ', + ' ', + ' .. py:attribute:: EnumCls.val4', + ' :module: target', + ' :annotation: = 34', + ' ' + ] + + # checks for an attribute of EnumClass + actual = do_autodoc(app, 'attribute', 'target.EnumCls.val1', options) + assert list(actual) == [ + '', + '.. py:attribute:: EnumCls.val1', + ' :module: target', + ' :annotation: = 12', + '', + ' doc for val1', + ' ' + ] + + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_descriptor_class(app): + options = {"members": ['CustomDataDescriptor', 'CustomDataDescriptor2']} + actual = do_autodoc(app, 'module', 'target', options) + assert list(actual) == [ + '', + '.. py:module:: target', + '', + '', + '.. py:class:: CustomDataDescriptor(doc)', + ' :module: target', + '', + ' Descriptor class docstring.', + ' ', + ' ', + ' .. py:method:: CustomDataDescriptor.meth()', + ' :module: target', + ' ', + ' Function.', + ' ', + '', + '.. py:class:: CustomDataDescriptor2(doc)', + ' :module: target', + '', + ' Descriptor class with custom metaclass docstring.', + ' ' + ] + + +@pytest.mark.sphinx('html', testroot='root') +def test_mocked_module_imports(app): + options = {"members": ['TestAutodoc', 'decoratedFunction']} + actual = do_autodoc(app, 'module', 'autodoc_missing_imports', options) + assert list(actual) == [ + '', + '.. py:module:: autodoc_missing_imports', + '', + '', + '.. py:class:: TestAutodoc', + ' :module: autodoc_missing_imports', + '', + ' TestAutodoc docstring.', + ' ', + ' ', + ' .. py:method:: TestAutodoc.decoratedMethod()', + ' :module: autodoc_missing_imports', + ' ', + ' TestAutodoc::decoratedMethod docstring', + ' ', + '', + '.. py:function:: decoratedFunction()', + ' :module: autodoc_missing_imports', + '', + ' decoratedFunction docstring', + ' ' + ] @pytest.mark.skipif(sys.version_info < (3, 4), From 6754b531b91c85d8695605d9a3499737bdb1ec3b Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 28 Jul 2018 18:48:44 +0900 Subject: [PATCH 054/174] Do test with py37 --- .travis.yml | 6 +++++- tox.ini | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 86d7559ca..40c2a639a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -24,8 +24,12 @@ matrix: env: - TOXENV=py36 - PYTEST_ADDOPTS="--cov ./ --cov-append --cov-config setup.cfg" - - python: 'nightly' + - python: '3.7' env: TOXENV=py37 + dist: xenial + sudo: true + - python: 'nightly' + env: TOXENV=py38 - python: '3.6' env: TOXENV=docs - python: '3.6' diff --git a/tox.ini b/tox.ini index d2f253fb3..6715fd338 100644 --- a/tox.ini +++ b/tox.ini @@ -1,13 +1,13 @@ [tox] minversion = 2.0 -envlist = docs,flake8,mypy,coverage,py{27,34,35,36,py},du{11,12,13,14} +envlist = docs,flake8,mypy,coverage,py{27,34,35,36,37,38,py},du{11,12,13,14} [testenv] usedevelop = True passenv = https_proxy http_proxy no_proxy PERL PERL5LIB PYTEST_ADDOPTS EPUBCHECK_PATH description = - py{27,34,35,36,py}: Run unit tests against {envname}. + py{27,34,35,36,37,38,py}: Run unit tests against {envname}. du{11,12,13,14}: Run unit tests with the given version of docutils. # TODO(stephenfin) Replace this with the 'extras' config option when tox 2.4 is From f969edfaa831608129ffcbbe68b235dd6a466836 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 28 Jul 2018 20:19:30 +0900 Subject: [PATCH 055/174] Fix flake8 violations on tests --- tests/roots/test-ext-viewcode-find/conf.py | 3 --- .../not_a_package/submodule.py | 1 + tests/roots/test-inheritance/dummy/test.py | 2 +- tests/roots/test-latex-equations/conf.py | 1 - tests/test_application.py | 1 - tests/test_autodoc.py | 1 - tests/test_build_gettext.py | 4 ++-- tests/test_config.py | 12 ++++++------ tests/test_domain_cpp.py | 12 ++++++------ tests/test_environment_toctree.py | 3 ++- tests/test_ext_apidoc.py | 2 -- tests/test_ext_doctest.py | 1 + 12 files changed, 19 insertions(+), 24 deletions(-) diff --git a/tests/roots/test-ext-viewcode-find/conf.py b/tests/roots/test-ext-viewcode-find/conf.py index 3f5ddc175..98f9e5fbb 100644 --- a/tests/roots/test-ext-viewcode-find/conf.py +++ b/tests/roots/test-ext-viewcode-find/conf.py @@ -1,8 +1,5 @@ # -*- coding: utf-8 -*- -import os -import sys - extensions = ['sphinx.ext.viewcode'] master_doc = 'index' exclude_patterns = ['_build'] diff --git a/tests/roots/test-ext-viewcode-find/not_a_package/submodule.py b/tests/roots/test-ext-viewcode-find/not_a_package/submodule.py index fb697ab75..7bb36943b 100644 --- a/tests/roots/test-ext-viewcode-find/not_a_package/submodule.py +++ b/tests/roots/test-ext-viewcode-find/not_a_package/submodule.py @@ -3,6 +3,7 @@ submodule """ raise RuntimeError('This module should not get imported') + def decorator(f): return f diff --git a/tests/roots/test-inheritance/dummy/test.py b/tests/roots/test-inheritance/dummy/test.py index 318a3ed42..51bd9a7a4 100644 --- a/tests/roots/test-inheritance/dummy/test.py +++ b/tests/roots/test-inheritance/dummy/test.py @@ -1,4 +1,4 @@ -""" +r""" Test with a class diagram like this:: diff --git a/tests/roots/test-latex-equations/conf.py b/tests/roots/test-latex-equations/conf.py index 6122e9212..101e491e0 100644 --- a/tests/roots/test-latex-equations/conf.py +++ b/tests/roots/test-latex-equations/conf.py @@ -2,4 +2,3 @@ master_doc = 'equations' extensions = ['sphinx.ext.imgmath'] - diff --git a/tests/test_application.py b/tests/test_application.py index efd55c487..27996fc91 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -12,7 +12,6 @@ import pytest from docutils import nodes from sphinx.errors import ExtensionError -from sphinx.domains import Domain from sphinx.testing.util import strip_escseq from sphinx.util import logging diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 3c125cb96..ce937cd4a 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -1249,7 +1249,6 @@ def test_enum_class(app): ] - @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_descriptor_class(app): options = {"members": ['CustomDataDescriptor', 'CustomDataDescriptor2']} diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index 18731855f..ec09eaf21 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -175,8 +175,8 @@ def test_gettext_template_msgid_order_in_sphinxpot(app): result = (app.outdir / 'sphinx.pot').text(encoding='utf-8') assert re.search( ('msgid "Template 1".*' - 'msgid "This is Template 1\.".*' + 'msgid "This is Template 1\\.".*' 'msgid "Template 2".*' - 'msgid "This is Template 2\.".*'), + 'msgid "This is Template 2\\.".*'), result, flags=re.S) diff --git a/tests/test_config.py b/tests/test_config.py index 6a910ecfc..0f0246c0b 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -172,20 +172,20 @@ def make_app_with_empty_project(make_app, tempdir): def test_needs_sphinx(make_app_with_empty_project): make_app = make_app_with_empty_project # micro version - app = make_app(confoverrides={'needs_sphinx': '1.3.3'}) # OK: less - app = make_app(confoverrides={'needs_sphinx': '1.3.4'}) # OK: equals + make_app(confoverrides={'needs_sphinx': '1.3.3'}) # OK: less + make_app(confoverrides={'needs_sphinx': '1.3.4'}) # OK: equals with pytest.raises(VersionRequirementError): make_app(confoverrides={'needs_sphinx': '1.3.5'}) # NG: greater # minor version - app = make_app(confoverrides={'needs_sphinx': '1.2'}) # OK: less - app = make_app(confoverrides={'needs_sphinx': '1.3'}) # OK: equals + make_app(confoverrides={'needs_sphinx': '1.2'}) # OK: less + make_app(confoverrides={'needs_sphinx': '1.3'}) # OK: equals with pytest.raises(VersionRequirementError): make_app(confoverrides={'needs_sphinx': '1.4'}) # NG: greater # major version - app = make_app(confoverrides={'needs_sphinx': '0'}) # OK: less - app = make_app(confoverrides={'needs_sphinx': '1'}) # OK: equals + make_app(confoverrides={'needs_sphinx': '0'}) # OK: less + make_app(confoverrides={'needs_sphinx': '1'}) # OK: equals with pytest.raises(VersionRequirementError): make_app(confoverrides={'needs_sphinx': '2'}) # NG: greater diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index ab956fefe..e13381817 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -760,9 +760,9 @@ def test_xref_consistency(app, status, warning): def classes(role, tag): pattern = (r'{role}-role:.*?' - '<(?P{tag}) .*?class=["\'](?P.*?)["\'].*?>' - '.*' - '').format(role=role, tag=tag) + r'<(?P{tag}) .*?class=["\'](?P.*?)["\'].*?>' + r'.*' + r'').format(role=role, tag=tag) result = re.search(pattern, output) expect = '''\ Pattern for role `{role}` with tag `{tag}` @@ -783,17 +783,17 @@ not found in `{test}` self.content_classes[tag] = classes(role, tag) # not actually used as a reference point - #code_role = RoleClasses('code', 'code', []) + # code_role = RoleClasses('code', 'code', []) any_role = RoleClasses('any', 'a', ['code']) cpp_any_role = RoleClasses('cpp-any', 'a', ['code']) # NYI: consistent looks - #texpr_role = RoleClasses('cpp-texpr', 'span', ['a', 'code']) + # texpr_role = RoleClasses('cpp-texpr', 'span', ['a', 'code']) expr_role = RoleClasses('cpp-expr', 'code', ['a']) texpr_role = RoleClasses('cpp-texpr', 'span', ['a', 'span']) # XRefRole-style classes - ## any and cpp:any do not put these classes at the root + # any and cpp:any do not put these classes at the root # n.b. the generic any machinery finds the specific 'cpp-class' object type expect = 'any uses XRefRole classes' diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index 3fbb21856..618b7afe3 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -113,7 +113,8 @@ def test_glob(app): maxdepth=-1, numbered=0, includefiles=includefiles, entries=[(None, 'foo'), (None, 'bar/index'), (None, 'bar/bar_1'), (None, 'bar/bar_2'), (None, 'bar/bar_3'), (None, 'baz'), - (None, 'qux/index'), ('hyperref', 'https://sphinx-doc.org/?q=sphinx')]) + (None, 'qux/index'), + ('hyperref', 'https://sphinx-doc.org/?q=sphinx')]) assert_node(toctree[0][1][1], [list_item, ([compact_paragraph, reference, "reversed order"], [bullet_list, addnodes.toctree])]) # [0][1][1][1][0] diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index 8c81a6e12..3d1517929 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -387,8 +387,6 @@ def extract_toc(path): coderoot='test-apidoc-subpackage-in-toc', options=['--separate'] ) - - def test_subpackage_in_toc(make_app, apidoc): """Make sure that empty subpackages with non-empty subpackages in them are not skipped (issue #4520) diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index 4aad0d274..7137af31b 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -9,6 +9,7 @@ :license: BSD, see LICENSE for details. """ import os + import pytest from packaging.specifiers import InvalidSpecifier from packaging.version import InvalidVersion From 7ee868fb185b9e8c2a5b9636ce5f4cf63b367059 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 28 Jul 2018 22:37:32 +0900 Subject: [PATCH 056/174] Add testcases for autodoc_default_flags --- tests/test_autodoc.py | 62 +++++++++++++++++++++++++++++-------------- 1 file changed, 42 insertions(+), 20 deletions(-) diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index ce937cd4a..168002c52 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -19,9 +19,9 @@ from docutils.statemachine import ViewList from six import PY3 from sphinx.ext.autodoc import ( - AutoDirective, ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL, Options + AutoDirective, ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL ) -from sphinx.ext.autodoc.directive import DocumenterBridge +from sphinx.ext.autodoc.directive import DocumenterBridge, process_documenter_options from sphinx.testing.util import SphinxTestApp, Struct # NOQA from sphinx.util import logging from sphinx.util.docutils import LoggingReporter @@ -30,8 +30,10 @@ app = None def do_autodoc(app, objtype, name, options={}): - bridge = DocumenterBridge(app.env, LoggingReporter(''), Options(options), 1) - documenter = app.registry.documenters[objtype](bridge, name) + doccls = app.registry.documenters[objtype] + docoptions = process_documenter_options(doccls, app.config, options) + bridge = DocumenterBridge(app.env, LoggingReporter(''), docoptions, 1) + documenter = doccls(bridge, name) documenter.generate() return bridge.result @@ -770,8 +772,7 @@ def test_generate(): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autodoc_noindex(app): - options = {"members": [], - "noindex": True} + options = {"noindex": True} actual = do_autodoc(app, 'module', 'target', options) assert list(actual) == [ '', @@ -794,7 +795,7 @@ def test_autodoc_noindex(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autodoc_subclass_of_builtin_class(app): - options = {"members": ALL} + options = {"members": None} actual = do_autodoc(app, 'class', 'target.CustomDict', options) assert list(actual) == [ '', @@ -813,7 +814,7 @@ def test_autodoc_inner_class(app): else: builtins = ' alias of :class:`__builtin__.dict`' - options = {"members": ALL} + options = {"members": None} actual = do_autodoc(app, 'class', 'target.Outer', options) assert list(actual) == [ '', @@ -894,7 +895,7 @@ def test_autodoc_member_order(app): roger_method = ' .. py:classmethod:: Class.roger(a, e=5, f=6)' # case member-order='bysource' - options = {"members": ALL, + options = {"members": None, 'member-order': 'bysource', "undoc-members": True, 'private-members': True} @@ -921,7 +922,7 @@ def test_autodoc_member_order(app): ] # case member-order='groupwise' - options = {"members": ALL, + options = {"members": None, 'member-order': 'groupwise', "undoc-members": True, 'private-members': True} @@ -948,7 +949,7 @@ def test_autodoc_member_order(app): ] # case member-order=None - options = {"members": ALL, + options = {"members": None, "undoc-members": True, 'private-members': True} actual = do_autodoc(app, 'class', 'target.Class', options) @@ -1013,7 +1014,7 @@ def test_autodoc_class_scope(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autodoc_docstring_signature(app): - options = {"members": ALL} + options = {"members": None} actual = do_autodoc(app, 'class', 'target.DocstringSig', options) assert list(actual) == [ '', @@ -1098,7 +1099,7 @@ def test_autodoc_docstring_signature(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_class_attributes(app): - options = {"members": ALL, + options = {"members": None, "undoc-members": True} actual = do_autodoc(app, 'class', 'target.AttCls', options) assert list(actual) == [ @@ -1121,7 +1122,7 @@ def test_class_attributes(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_instance_attributes(app): - options = {"members": ALL} + options = {"members": None} actual = do_autodoc(app, 'class', 'target.InstAttCls', options) assert list(actual) == [ '', @@ -1169,7 +1170,7 @@ def test_instance_attributes(app): ] # pick up arbitrary attributes - options = {"members": ['ca1', 'ia1']} + options = {"members": 'ca1,ia1'} actual = do_autodoc(app, 'class', 'target.InstAttCls', options) assert list(actual) == [ '', @@ -1198,7 +1199,7 @@ def test_instance_attributes(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_enum_class(app): - options = {"members": ALL, + options = {"members": None, "undoc-members": True} actual = do_autodoc(app, 'class', 'target.EnumCls', options) assert list(actual) == [ @@ -1237,7 +1238,7 @@ def test_enum_class(app): ] # checks for an attribute of EnumClass - actual = do_autodoc(app, 'attribute', 'target.EnumCls.val1', options) + actual = do_autodoc(app, 'attribute', 'target.EnumCls.val1') assert list(actual) == [ '', '.. py:attribute:: EnumCls.val1', @@ -1251,7 +1252,7 @@ def test_enum_class(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_descriptor_class(app): - options = {"members": ['CustomDataDescriptor', 'CustomDataDescriptor2']} + options = {"members": 'CustomDataDescriptor,CustomDataDescriptor2'} actual = do_autodoc(app, 'module', 'target', options) assert list(actual) == [ '', @@ -1280,7 +1281,7 @@ def test_descriptor_class(app): @pytest.mark.sphinx('html', testroot='root') def test_mocked_module_imports(app): - options = {"members": ['TestAutodoc', 'decoratedFunction']} + options = {"members": 'TestAutodoc,decoratedFunction'} actual = do_autodoc(app, 'module', 'autodoc_missing_imports', options) assert list(actual) == [ '', @@ -1345,6 +1346,27 @@ def test_partialmethod(app): # TODO: this condition should be updated after 3.7-final release. expected = '\n'.join(expected).replace(' -> None', '').split('\n') - options = {"members": ALL} + options = {"members": None} actual = do_autodoc(app, 'class', 'target.partialmethod.Cell', options) assert list(actual) == expected + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_default_flags(app): + # no settings + actual = do_autodoc(app, 'class', 'target.EnumCls') + assert ' .. py:attribute:: EnumCls.val1' not in actual + assert ' .. py:attribute:: EnumCls.val4' not in actual + + # with :members: + app.config.autodoc_default_flags = ['members'] + actual = do_autodoc(app, 'class', 'target.EnumCls') + assert ' .. py:attribute:: EnumCls.val1' in actual + assert ' .. py:attribute:: EnumCls.val4' not in actual + + # with :members: and :undoc-members: + app.config.autodoc_default_flags = ['members', + 'undoc-members'] + actual = do_autodoc(app, 'class', 'target.EnumCls') + assert ' .. py:attribute:: EnumCls.val1' in actual + assert ' .. py:attribute:: EnumCls.val4' in actual From afe46ef74ca43080010c356711193b7dde0df69c Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sat, 28 Jul 2018 21:12:05 +0200 Subject: [PATCH 057/174] #5186 add tests for `getQueryParameters()` and fix test description of `urldecode()` --- tests/js/doctools.js | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/tests/js/doctools.js b/tests/js/doctools.js index 32fd68c10..8533f7148 100644 --- a/tests/js/doctools.js +++ b/tests/js/doctools.js @@ -2,7 +2,7 @@ var DOCUMENTATION_OPTIONS = {}; describe('urldecode', function() { - it('should fail', function() { + it('should correctly decode URLs and replace `+`s with a spaces', function() { var test_encoded_string = '%D1%88%D0%B5%D0%BB%D0%BB%D1%8B+%D1%88%D0%B5%D0%BB%D0%BB%D1%8B'; var test_decoded_string = 'шеллы шеллы'; @@ -10,3 +10,23 @@ describe('urldecode', function() { }); }); + +describe('getQueryParameters', function() { + var paramString = '?q=test+this&check_keywords=yes&area=default'; + var queryParamObject = { + area: ['default'], + check_keywords: ['yes'], + q: ['test this'] + }; + + it('should correctly create query parameter object from string', function() { + expect(jQuery.getQueryParameters(paramString)).toEqual(queryParamObject); + }); + + it('should correctly create query param object from URL params', function() { + history.pushState({}, '_', window.location + paramString); + expect(jQuery.getQueryParameters()).toEqual(queryParamObject); + }); + +}); + From 7218fe9dca4299e141c369f89418c7f800d3a6cb Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 28 Jul 2018 19:48:21 +0900 Subject: [PATCH 058/174] Deprecate whole of sphinx.ext.mathbase --- CHANGES | 3 ++ doc/extdev/index.rst | 15 +++++++++ sphinx/ext/imgmath.py | 7 ++-- sphinx/ext/jsmath.py | 2 +- sphinx/ext/mathbase.py | 57 ++++++--------------------------- sphinx/ext/mathjax.py | 2 +- sphinx/util/math.py | 71 +++++++++++++++++++++++++++++++++++++++++ sphinx/util/parallel.py | 1 + sphinx/writers/latex.py | 6 +--- 9 files changed, 106 insertions(+), 58 deletions(-) create mode 100644 sphinx/util/math.py diff --git a/CHANGES b/CHANGES index 009b96d6d..d9dbf2fc4 100644 --- a/CHANGES +++ b/CHANGES @@ -107,6 +107,7 @@ Deprecated * ``sphinx.writers.html5.HTMLTranslator.highlightlang_base`` is deprecated * ``sphinx.writers.html5.HTMLTranslator.highlightlangopts`` is deprecated * ``sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold`` is deprecated +* ``sphinx.ext.mathbase`` extension is deprecated * ``sphinx.ext.mathbase.math`` node is deprecated * ``sphinx.ext.mathbase.displaymath`` node is deprecated * ``sphinx.ext.mathbase.eqref`` node is deprecated @@ -114,6 +115,8 @@ Deprecated * ``sphinx.ext.mathbase.MathDomain`` is deprecated * ``sphinx.ext.mathbase.setup_math()`` is deprecated * ``sphinx.highlighting.PygmentsBridge.unhighlight()`` is deprecated +* ``sphinx.ext.mathbase.get_node_equation_number()`` is deprecated +* ``sphinx.ext.mathbase.wrap_displaymath()`` is deprecated * The ``trim_doctest_flags`` argument of ``sphinx.highlighting.PygmentsBridge`` is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 0002af853..bfc004c45 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -142,6 +142,11 @@ The following is a list of deprecated interface. - 3.0 - N/A + * - ``sphinx.ext.mathbase`` + - 1.8 + - 3.0 + - N/A + * - ``sphinx.ext.mathbase.MathDomain`` - 1.8 - 3.0 @@ -157,6 +162,16 @@ The following is a list of deprecated interface. - 3.0 - N/A + * - ``sphinx.ext.mathbase.get_node_equation_number()`` + - 1.8 + - 3.0 + - ``sphinx.util.math.get_node_equation_number()`` + + * - ``sphinx.ext.mathbase.wrap_displaymath()`` + - 1.8 + - 3.0 + - ``sphinx.util.math.wrap_displaymath()`` + * - ``sphinx.ext.mathbase.math`` (node) - 1.8 - 3.0 diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index eae577f2a..3c4ee4f23 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -23,10 +23,9 @@ from six import text_type import sphinx from sphinx.errors import SphinxError -from sphinx.ext.mathbase import get_node_equation_number -from sphinx.ext.mathbase import wrap_displaymath from sphinx.locale import _, __ from sphinx.util import logging +from sphinx.util.math import get_node_equation_number, wrap_displaymath from sphinx.util.osutil import ensuredir, ENOENT, cd from sphinx.util.png import read_png_depth, write_png_depth from sphinx.util.pycompat import sys_encoding @@ -34,10 +33,10 @@ from sphinx.util.pycompat import sys_encoding if False: # For type annotation from typing import Any, Dict, List, Tuple # NOQA + from sphinx.addnodes import displaymath # NOQA from sphinx.application import Sphinx # NOQA from sphinx.builders import Builder # NOQA from sphinx.config import Config # NOQA - from sphinx.ext.mathbase import displaymath # NOQA logger = logging.getLogger(__name__) @@ -315,7 +314,7 @@ def html_visit_math(self, node): def html_visit_displaymath(self, node): - # type: (nodes.NodeVisitor, displaymath) -> None + # type: (nodes.NodeVisitor, nodes.math_block) -> None if node['nowrap']: latex = node.astext() else: diff --git a/sphinx/ext/jsmath.py b/sphinx/ext/jsmath.py index 5dbb20fba..0ee42050c 100644 --- a/sphinx/ext/jsmath.py +++ b/sphinx/ext/jsmath.py @@ -14,8 +14,8 @@ from docutils import nodes import sphinx from sphinx.errors import ExtensionError -from sphinx.ext.mathbase import get_node_equation_number from sphinx.locale import _ +from sphinx.util.math import get_node_equation_number if False: # For type annotation diff --git a/sphinx/ext/mathbase.py b/sphinx/ext/mathbase.py index 77cf43c8b..58525f0cf 100644 --- a/sphinx/ext/mathbase.py +++ b/sphinx/ext/mathbase.py @@ -28,57 +28,20 @@ if False: def get_node_equation_number(writer, node): # type: (Writer, nodes.Node) -> unicode - if writer.builder.config.math_numfig and writer.builder.config.numfig: - figtype = 'displaymath' - if writer.builder.name == 'singlehtml': - key = u"%s/%s" % (writer.docnames[-1], figtype) - else: - key = figtype - - id = node['ids'][0] - number = writer.builder.fignumbers.get(key, {}).get(id, ()) - number = '.'.join(map(str, number)) - else: - number = node['number'] - - return number + warnings.warn('sphinx.ext.mathbase.get_node_equation_number() is moved to ' + 'sphinx.util.math package.', + RemovedInSphinx30Warning) + from sphinx.util.math import get_node_equation_number + return get_node_equation_number(writer, node) def wrap_displaymath(text, label, numbering): # type: (unicode, unicode, bool) -> unicode - def is_equation(part): - # type: (unicode) -> unicode - return part.strip() - - if label is None: - labeldef = '' - else: - labeldef = r'\label{%s}' % label - numbering = True - - parts = list(filter(is_equation, text.split('\n\n'))) - equations = [] - if len(parts) == 0: - return '' - elif len(parts) == 1: - if numbering: - begin = r'\begin{equation}' + labeldef - end = r'\end{equation}' - else: - begin = r'\begin{equation*}' + labeldef - end = r'\end{equation*}' - equations.append('\\begin{split}%s\\end{split}\n' % parts[0]) - else: - if numbering: - begin = r'\begin{align}%s\!\begin{aligned}' % labeldef - end = r'\end{aligned}\end{align}' - else: - begin = r'\begin{align*}%s\!\begin{aligned}' % labeldef - end = r'\end{aligned}\end{align*}' - for part in parts: - equations.append('%s\\\\\n' % part.strip()) - - return '%s\n%s%s' % (begin, ''.join(equations), end) + warnings.warn('sphinx.ext.mathbase.wrap_displaymath() is moved to ' + 'sphinx.util.math package.', + RemovedInSphinx30Warning) + from sphinx.util.math import wrap_displaymath + return wrap_displaymath(text, label, numbering) def is_in_section_title(node): diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index 20d5866c5..02bccd762 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -15,8 +15,8 @@ from docutils import nodes import sphinx from sphinx.errors import ExtensionError -from sphinx.ext.mathbase import get_node_equation_number from sphinx.locale import _ +from sphinx.util.math import get_node_equation_number if False: # For type annotation diff --git a/sphinx/util/math.py b/sphinx/util/math.py new file mode 100644 index 000000000..b960613c0 --- /dev/null +++ b/sphinx/util/math.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- +""" + sphinx.util.math + ~~~~~~~~~~~~~~~~ + + Utility functions for math. + + :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + + +if False: + # For type annotation + from docutils import nodes # NOQA + from docutils.writers.html4css1 import Writer # NOQA + + +def get_node_equation_number(writer, node): + # type: (Writer, nodes.Node) -> unicode + if writer.builder.config.math_numfig and writer.builder.config.numfig: + figtype = 'displaymath' + if writer.builder.name == 'singlehtml': + key = u"%s/%s" % (writer.docnames[-1], figtype) + else: + key = figtype + + id = node['ids'][0] + number = writer.builder.fignumbers.get(key, {}).get(id, ()) + number = '.'.join(map(str, number)) + else: + number = node['number'] + + return number + + +def wrap_displaymath(text, label, numbering): + # type: (unicode, unicode, bool) -> unicode + def is_equation(part): + # type: (unicode) -> unicode + return part.strip() + + if label is None: + labeldef = '' + else: + labeldef = r'\label{%s}' % label + numbering = True + + parts = list(filter(is_equation, text.split('\n\n'))) + equations = [] + if len(parts) == 0: + return '' + elif len(parts) == 1: + if numbering: + begin = r'\begin{equation}' + labeldef + end = r'\end{equation}' + else: + begin = r'\begin{equation*}' + labeldef + end = r'\end{equation*}' + equations.append('\\begin{split}%s\\end{split}\n' % parts[0]) + else: + if numbering: + begin = r'\begin{align}%s\!\begin{aligned}' % labeldef + end = r'\end{aligned}\end{align}' + else: + begin = r'\begin{align*}%s\!\begin{aligned}' % labeldef + end = r'\end{aligned}\end{align*}' + for part in parts: + equations.append('%s\\\\\n' % part.strip()) + + return '%s\n%s%s' % (begin, ''.join(equations), end) diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py index fe2577308..066e3c93a 100644 --- a/sphinx/util/parallel.py +++ b/sphinx/util/parallel.py @@ -8,6 +8,7 @@ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ +from __future__ import absolute_import import os import time diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index b7d80860b..1fef2cea5 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -2544,11 +2544,7 @@ class LaTeXTranslator(nodes.NodeVisitor): self.body.append(r'\label{%s}' % label) self.body.append(node.astext()) else: - def is_equation(part): - # type: (unicode) -> unicode - return part.strip() - - from sphinx.ext.mathbase import wrap_displaymath + from sphinx.util.math import wrap_displaymath self.body.append(wrap_displaymath(node.astext(), label, self.builder.config.math_number_all)) raise nodes.SkipNode From 6b9b063ee69f896585f98bea556296479a2d0a77 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 29 Jul 2018 14:10:07 +0900 Subject: [PATCH 059/174] Fix #5213: i18n: sphinx-build crashes if node having tupled-attributed --- sphinx/util/nodes.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index 448dd2eaa..7e4dba01e 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -56,7 +56,10 @@ def repr_domxml(node, length=80): returns full of DOM XML representation. :return: DOM XML representation """ - text = node.asdom().toxml() + try: + text = node.asdom().toxml() + except Exception: + text = text_type(node) if length and len(text) > length: text = text[:length] + '...' return text From 1302d785fb627ba811a24ecbe74db15b3fd71374 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 29 Jul 2018 18:50:22 +0900 Subject: [PATCH 060/174] linkcheck: Drop application/xml from Accept header --- sphinx/builders/linkcheck.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index 8079b680a..12936730a 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -123,8 +123,7 @@ class CheckExternalLinksBuilder(Builder): kwargs = { 'allow_redirects': True, 'headers': { - 'Accept': ('text/html,application/xhtml+xml,' - 'application/xml;q=0.9,*/*;q=0.8') + 'Accept': 'text/html,application/xhtml+xml;q=0.9,*/*;q=0.8' }, } if self.app.config.linkcheck_timeout: From 96c82b3f725e9d8e9b5295af25c58f408d9bdd9c Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 29 Jul 2018 18:53:03 +0900 Subject: [PATCH 061/174] Update CHANGES for PR #5140 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index 009b96d6d..e9e44be24 100644 --- a/CHANGES +++ b/CHANGES @@ -179,6 +179,7 @@ Features added * #2820: autoclass directive supports nested class * Add ``app.add_html_math_renderer()`` to register a math renderer for HTML * Apply :confval:`trim_doctest_flags` to all builders (cf. text, manpages) +* #5140: linkcheck: Add better Accept header to HTTP client Bugs fixed ---------- From b0c3a8fc8e00b31899eca0859b63e1e38f76d58e Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 29 Jul 2018 21:40:48 +0900 Subject: [PATCH 062/174] Move sphinx.make_mode to under sphinx.cmd --- sphinx/cmd/build.py | 2 +- sphinx/{ => cmd}/make_mode.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) rename sphinx/{ => cmd}/make_mode.py (99%) diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py index 86a1b5633..f21a5ac45 100644 --- a/sphinx/cmd/build.py +++ b/sphinx/cmd/build.py @@ -200,7 +200,7 @@ files can be built by specifying individual filenames. def make_main(argv=sys.argv[1:]): # type: ignore # type: (List[unicode]) -> int """Sphinx build "make mode" entry.""" - from sphinx import make_mode + from sphinx.cmd import make_mode return make_mode.run_make_mode(argv[1:]) diff --git a/sphinx/make_mode.py b/sphinx/cmd/make_mode.py similarity index 99% rename from sphinx/make_mode.py rename to sphinx/cmd/make_mode.py index ae19e93ee..231e3af10 100644 --- a/sphinx/make_mode.py +++ b/sphinx/cmd/make_mode.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """ - sphinx.make_mode - ~~~~~~~~~~~~~~~~ + sphinx.cmd.make_mode + ~~~~~~~~~~~~~~~~~~~~ sphinx-build -M command-line handling. From 4e30f494c413e8c360aac3a3a399cf12eec5c704 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 29 Jul 2018 21:48:14 +0900 Subject: [PATCH 063/174] Add new sphinx.make_mode package for compatibility --- sphinx/make_mode.py | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 sphinx/make_mode.py diff --git a/sphinx/make_mode.py b/sphinx/make_mode.py new file mode 100644 index 000000000..4510fc0eb --- /dev/null +++ b/sphinx/make_mode.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +""" + sphinx.make_mode + ~~~~~~~~~~~~~~~~ + + sphinx-build -M command-line handling. + + This replaces the old, platform-dependent and once-generated content + of Makefile / make.bat. + + This is in its own module so that importing it is fast. It should not + import the main Sphinx modules (like sphinx.applications, sphinx.builders). + + :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + +import warnings + +from sphinx.cmd import make_mode +from sphinx.deprecation import RemovedInSphinx30Warning + + +BUILDERS = make_mode.BUILDERS + + +class Make(make_mode.Make): + def __init__(self, *args): + warnings.warn('sphinx.make_mode.Make is deprecated. ' + 'Please use sphinx.cmd.make_mode.Make instead.', + RemovedInSphinx30Warning) + super(Make, self).__init__(*args) + + +def run_make_mode(args): + warnings.warn('sphinx.make_mode.run_make_mode() is deprecated. ' + 'Please use sphinx.cmd.make_mode.run_make_mode() instead.', + RemovedInSphinx30Warning) + return make_mode.run_make_mode(args) From c8a66b73cf84a3466c2062df61fa8ebd9ecc7835 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 29 Jul 2018 21:49:01 +0900 Subject: [PATCH 064/174] Update CHANGES --- CHANGES | 1 + doc/extdev/index.rst | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/CHANGES b/CHANGES index 009b96d6d..62c85884b 100644 --- a/CHANGES +++ b/CHANGES @@ -59,6 +59,7 @@ Deprecated based directives. * ``sphinx.util.docutils.directive_helper()`` is deprecated * ``sphinx.cmdline`` is deprecated +* ``sphinx.make_mode`` is deprecated * ``sphinx.locale.l_()`` is deprecated * #2157: helper function ``warn()`` for HTML themes is deprecated * ``app.override_domain()`` is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 0002af853..884b8b9c1 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -410,6 +410,11 @@ The following is a list of deprecated interface. - 3.0 - ``sphinx.cmd.build`` + * - ``sphinx.make_mode`` + - 1.8 + - 3.0 + - ``sphinx.cmd.make_mode`` + * - ``sphinx.locale.l_()`` - 1.8 - 3.0 From da7a06b323e3990ce23125981016099a4e00db24 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 1 Jun 2018 17:23:08 +0900 Subject: [PATCH 065/174] WIP: #726, #969: Add mathjax_config --- doc/usage/extensions/math.rst | 17 +++++++++++++++++ sphinx/builders/html.py | 13 +++++++++---- sphinx/ext/mathjax.py | 7 +++++++ tests/test_ext_math.py | 12 ++++++++++++ 4 files changed, 45 insertions(+), 4 deletions(-) diff --git a/doc/usage/extensions/math.rst b/doc/usage/extensions/math.rst index 35f283846..9daa03186 100644 --- a/doc/usage/extensions/math.rst +++ b/doc/usage/extensions/math.rst @@ -168,6 +168,23 @@ Sphinx. The default is empty (``{}``). +.. confval:: mathjax_config + + The inline configuration options for mathjax. The value is used as a + parameter of ``MathJax.Hub.Config()``. For more information, please + read `Using in-line configuration options`_. + + For example:: + + mathjax_config = { + 'extensions': ['tex2jax.js'], + 'jax': ['input/TeX', 'output/HTML-CSS'], + } + + The default is empty (not configured). + +.. _Using in-line configuration options: http://docs.mathjax.org/en/latest/configuration.html#using-in-line-configuration-options + :mod:`sphinx.ext.jsmath` -- Render math via JavaScript ------------------------------------------------------ diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index f08cb909f..0deaec707 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -420,7 +420,7 @@ class StandaloneHTMLBuilder(Builder): def add_js_file(self, filename, **kwargs): # type: (unicode, **unicode) -> None - if '://' not in filename: + if filename and '://' not in filename: filename = posixpath.join('_static', filename) self.script_files.append(JavaScript(filename, **kwargs)) # type: ignore @@ -1630,17 +1630,22 @@ def setup_js_tag_helper(app, pagename, templatexname, context, doctree): def js_tag(js): # type: (JavaScript) -> unicode attrs = [] + body = '' # type: unicode if isinstance(js, JavaScript): for key in sorted(js.attributes): value = js.attributes[key] if value is not None: - attrs.append('%s="%s"' % (key, htmlescape(value, True))) - attrs.append('src="%s"' % pathto(js.filename, resource=True)) + if key == 'body': + body = value + else: + attrs.append('%s="%s"' % (key, htmlescape(value, True))) + if js.filename: + attrs.append('src="%s"' % pathto(js.filename, resource=True)) else: # str value (old styled) attrs.append('type="text/javascript"') attrs.append('src="%s"' % pathto(js, resource=True)) - return '' % ' '.join(attrs) + return '' % (' '.join(attrs), body) context['js_tag'] = js_tag diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index 20d5866c5..341eb12c8 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -11,6 +11,8 @@ :license: BSD, see LICENSE for details. """ +import json + from docutils import nodes import sphinx @@ -79,6 +81,10 @@ def builder_inited(app): options.update(app.config.mathjax_options) app.builder.add_js_file(app.config.mathjax_path, **options) # type: ignore + if app.config.mathjax_config: + body = "MathJax.Hub.Config(%s)" % json.dumps(app.config.mathjax_config) + app.builder.add_js_file(None, type="text/x-mathjax-config", body=body) # type: ignore # NOQA + def setup(app): # type: (Sphinx) -> Dict[unicode, Any] @@ -94,6 +100,7 @@ def setup(app): app.add_config_value('mathjax_options', {}, 'html') app.add_config_value('mathjax_inline', [r'\(', r'\)'], 'html') app.add_config_value('mathjax_display', [r'\[', r'\]'], 'html') + app.add_config_value('mathjax_config', None, 'html') app.connect('builder-inited', builder_inited) return {'version': sphinx.__display_version__, 'parallel_read_safe': True} diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index 99940977b..8f24349a4 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -249,3 +249,15 @@ def test_math_compat(app, status, warning): [nodes.math_block, "e^{i\\pi}+1=0\n\n"], [nodes.paragraph, "Multi math equations"], [nodes.math_block, "E = mc^2"])) + + +@pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinx.ext.mathjax'], + 'mathjax_config': {'extensions': ['tex2jax.js']}}) +def test_mathjax_config(app, status, warning): + app.builder.build_all() + + content = (app.outdir / 'index.html').text() + assert ('' in content) From 90246b82b5d1add2086b72861eb44f67f514f4df Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 29 Jul 2018 21:57:34 +0900 Subject: [PATCH 066/174] Check latex_elements at config-inited event --- CHANGES | 1 + doc/extdev/index.rst | 5 +++++ sphinx/builders/latex/__init__.py | 8 +++++++- sphinx/writers/latex.py | 18 ++++++++++-------- tests/test_config.py | 4 ++-- 5 files changed, 25 insertions(+), 11 deletions(-) diff --git a/CHANGES b/CHANGES index 009b96d6d..af265c3ce 100644 --- a/CHANGES +++ b/CHANGES @@ -96,6 +96,7 @@ Deprecated * ``sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()`` is deprecated +* ``sphinx.writers.latex.LaTeXTranslator.check_latex_elements()`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.bibitems`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.hlsettingstack`` is deprecated * ``sphinx.writers.latex.ExtBabel.get_shorthandoff()`` is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 0002af853..7bdcc4a9c 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -282,6 +282,11 @@ The following is a list of deprecated interface. - 3.0 - N/A + * - ``sphinx.writers.latex.LaTeXTranslator.check_latex_elements()`` + - 1.8 + - 3.0 + - Nothing + * - ``sphinx.application.CONFIG_FILENAME`` - 1.8 - 3.0 diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py index c4e92ae5b..bbbcce0dc 100644 --- a/sphinx/builders/latex/__init__.py +++ b/sphinx/builders/latex/__init__.py @@ -34,7 +34,7 @@ from sphinx.util.docutils import SphinxFileOutput, new_document from sphinx.util.fileutil import copy_asset_file from sphinx.util.nodes import inline_all_toctrees from sphinx.util.osutil import SEP, make_filename -from sphinx.writers.latex import LaTeXWriter, LaTeXTranslator +from sphinx.writers.latex import DEFAULT_SETTINGS, LaTeXWriter, LaTeXTranslator if False: # For type annotation @@ -373,6 +373,12 @@ def validate_config_values(app, config): 'Please use u"..." notation instead): %r') % (document,) ) + for key in list(config.latex_elements): + if key not in DEFAULT_SETTINGS: + msg = __("Unknown configure key: latex_elements[%r]. ignored.") + logger.warning(msg % key) + config.latex_elements.pop(key) + def default_latex_engine(config): # type: (Config) -> unicode diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index b7d80860b..20d03df69 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -494,7 +494,6 @@ class LaTeXTranslator(nodes.NodeVisitor): 'babel': '\\usepackage{babel}', }) # allow the user to override them all - self.check_latex_elements() self.elements.update(builder.config.latex_elements) # but some have other interface in config file @@ -719,13 +718,6 @@ class LaTeXTranslator(nodes.NodeVisitor): self.body = self.bodystack.pop() return body - def check_latex_elements(self): - # type: () -> None - for key in self.builder.config.latex_elements: - if key not in self.elements: - msg = __("Unknown configure key: latex_elements[%r] is ignored.") - logger.warning(msg % key) - def restrict_footnote(self, node): # type: (nodes.Node) -> None warnings.warn('LaTeXWriter.restrict_footnote() is deprecated.', @@ -2625,6 +2617,16 @@ class LaTeXTranslator(nodes.NodeVisitor): RemovedInSphinx30Warning) return [[self.builder.config.highlight_language, sys.maxsize]] + def check_latex_elements(self): + # type: () -> None + warnings.warn('check_latex_elements() is deprecated.', + RemovedInSphinx30Warning) + + for key in self.builder.config.latex_elements: + if key not in self.elements: + msg = __("Unknown configure key: latex_elements[%r] is ignored.") + logger.warning(msg % key) + # Import old modules here for compatibility # They should be imported after `LaTeXTranslator` to avoid recursive import. diff --git a/tests/test_config.py b/tests/test_config.py index 0f0246c0b..5dd05550c 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -22,7 +22,7 @@ from sphinx.testing.path import path @pytest.mark.sphinx(testroot='config', confoverrides={ 'master_doc': 'master', 'nonexisting_value': 'True', - 'latex_elements.docclass': 'scrartcl', + 'latex_elements.maketitle': 'blah blah blah', 'modindex_common_prefix': 'path1,path2'}) def test_core_config(app, status, warning): cfg = app.config @@ -34,7 +34,7 @@ def test_core_config(app, status, warning): # overrides assert cfg.master_doc == 'master' - assert cfg.latex_elements['docclass'] == 'scrartcl' + assert cfg.latex_elements['maketitle'] == 'blah blah blah' assert cfg.modindex_common_prefix == ['path1', 'path2'] # simple default values From 9a0097bef23ff9787b19416a99842b9db65c7b3d Mon Sep 17 00:00:00 2001 From: jfbu Date: Thu, 26 Jul 2018 14:07:21 +0200 Subject: [PATCH 067/174] Update LaTeX xindy docs --- doc/usage/configuration.rst | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index bc1e3ce13..99f5ddc91 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1926,26 +1926,23 @@ macros and environments, see also :doc:`/latex`. __ http://xindy.sourceforge.net/ - This option is ignored if :confval:`latex_engine` is ``'platex'`` - (Japanese documents) as :program:`mendex` is used in that case. + (Japanese documents; :program:`mendex` replaces :program:`makeindex` + then). - The default is ``True`` for ``'xelatex'`` or ``'lualatex'`` as :program:`makeindex`, if any indexed term starts with a non-ascii - character, creates ``.ind`` file containing invalid bytes for + character, creates ``.ind`` files containing invalid bytes for UTF-8 encoding. With ``'lualatex'`` this then breaks the PDF - build. Notice that :program:`xindy` supports most but not - all European languages. + build. - The default is ``False`` for ``'pdflatex'`` but ``True`` is recommended for non-English documents as soon as some indexed terms use non-ascii characters from the language script. - Cyrillic scripts are (transparently) supported with - ``'pdflatex'`` thanks to a specific Sphinx-contributed ``xindy`` - style file :file:`cyrLICRutf8.xdy`. - As :program:`xindy` does not support the same range of languages - as ``LaTeX/babel`` does, the default :program:`makeindex` for - ``'pdflatex'`` may be preferred in some circumstances, although - the index will be ill-formed probably. + Sphinx adds to :program:`xindy` base distribution some dedicated support + for using ``'pdflatex'`` engine with Cyrillic scripts. And whether with + ``'pdflatex'`` or Unicode engines, Cyrillic documents handle correctly the + indexing of Latin names, even with diacritics. .. versionadded:: 1.8 From 3bdf67a6b49c819d770b4730f13f658d91b2bfff Mon Sep 17 00:00:00 2001 From: jfbu Date: Wed, 18 Jul 2018 16:57:33 +0200 Subject: [PATCH 068/174] LaTeX: reduce hyperref warnings related to PDF bookmarks --- sphinx/texinputs/sphinx.sty | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index 6a885c3f5..18ed69525 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -1607,6 +1607,23 @@ \newcommand*\sphinxstylecodecontinues[1]{\footnotesize(#1)}% % figure legend comes after caption and may contain arbitrary body elements \newenvironment{sphinxlegend}{\par\small}{\par} +% reduce hyperref "Token not allowed in a PDF string" warnings on PDF builds +\AtBeginDocument{\pdfstringdefDisableCommands{% +% all "protected" macros possibly ending up in section titles should be here + \let\sphinxstyleemphasis \@firstofone + \let\sphinxstyleliteralemphasis \@firstofone + \let\sphinxstylestrong \@firstofone + \let\sphinxstyleliteralstrong \@firstofone + \let\sphinxstyleabbreviation \@firstofone + \let\sphinxstyleliteralintitle \@firstofone + \let\sphinxupquote \@firstofone + \let\sphinxstrong \@firstofone + \let\sphinxcode \@firstofone + \let\sphinxbfcode \@firstofone + \let\sphinxemail \@firstofone + \let\sphinxcrossref \@firstofone + \let\sphinxtermref \@firstofone +}} % For curly braces inside \index macro \def\sphinxleftcurlybrace{\{} From 685b6802952090ac27ffa14376abc36712723329 Mon Sep 17 00:00:00 2001 From: jfbu Date: Wed, 18 Jul 2018 16:58:41 +0200 Subject: [PATCH 069/174] LaTeX: update date of Sphinx LaTeX style file --- sphinx/texinputs/sphinx.sty | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index 18ed69525..2855f1a35 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -6,7 +6,7 @@ % \NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesPackage{sphinx}[2018/03/11 v1.7.2 LaTeX package (Sphinx markup)] +\ProvidesPackage{sphinx}[2018/07/18 v1.7.7 LaTeX package (Sphinx markup)] % provides \ltx@ifundefined % (many packages load ltxcmds: graphicx does for pdftex and lualatex but From f5e38f401086d43e64f03db7e7fc7704ba18eee9 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 09:27:55 +0200 Subject: [PATCH 070/174] LaTeX: avoid "The remreset package is obsolete" warnings in latex log --- sphinx/texinputs/sphinx.sty | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index 2855f1a35..63faeb058 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -183,7 +183,10 @@ % control caption around literal-block \RequirePackage{capt-of} \RequirePackage{needspace} -\RequirePackage{remreset}% provides \@removefromreset +% LaTeX 2018-04-01 and later provides \@removefromreset +\ltx@ifundefined{@removefromreset} + {\RequirePackage{remreset}} + {}% avoid warning % to make pdf with correct encoded bookmarks in Japanese % this should precede the hyperref package \ifx\kanjiskip\@undefined From cc6f0a26b1eb684157bddf74f1e9c2b369e86c17 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 09:48:13 +0200 Subject: [PATCH 071/174] Update CHANGES --- CHANGES | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGES b/CHANGES index 778df02e0..2f8f1fd9d 100644 --- a/CHANGES +++ b/CHANGES @@ -18,6 +18,10 @@ Bugs fixed * #5198: document not in toctree warning when including files only for parallel builds +* LaTeX: reduce "Token not allowed in a PDF string" hyperref warnings in latex + console output (refs: #5136) +* LaTeX: suppress "remreset Warning: The remreset package is obsolete" in latex + console output with recent LaTeX (refs: #5137) Testing -------- From 5ce05e2733ef0940cb1ef638cb2d60fd4557a006 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 09:50:37 +0200 Subject: [PATCH 072/174] Fix updated CHANGES --- CHANGES | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index 2f8f1fd9d..c22aefad5 100644 --- a/CHANGES +++ b/CHANGES @@ -19,9 +19,9 @@ Bugs fixed * #5198: document not in toctree warning when including files only for parallel builds * LaTeX: reduce "Token not allowed in a PDF string" hyperref warnings in latex - console output (refs: #5136) + console output (refs: #5236) * LaTeX: suppress "remreset Warning: The remreset package is obsolete" in latex - console output with recent LaTeX (refs: #5137) + console output with recent LaTeX (refs: #5237) Testing -------- From f0067f4a040a8b37afa3029c54806da9e32772e6 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 10:46:48 +0200 Subject: [PATCH 073/174] Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD" This reverts commit 9b2aac68ead15067205470ec28c94af909c080c0. --- doc/conf.py | 7 ++++++- doc/latex.rst | 22 ++-------------------- doc/usage/configuration.rst | 17 +++++++---------- sphinx/texinputs/sphinx.sty | 8 -------- sphinx/writers/latex.py | 2 +- 5 files changed, 16 insertions(+), 40 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 9cd3749c8..724d355d0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -64,7 +64,12 @@ latex_elements = { 'passoptionstopackages': '\\PassOptionsToPackage{svgnames}{xcolor}', 'preamble': '\\DeclareUnicodeCharacter{229E}{\\ensuremath{\\boxplus}}', 'fvset': '\\fvset{fontsize=auto}', - 'printindex': '\\footnotesize\\raggedright\\sphinxprintindex', + # fix missing index entry due to RTD doing only once pdflatex after makeindex + 'printindex': r''' +\IfFileExists{\jobname.ind} + {\footnotesize\raggedright\printindex} + {\begin{sphinxtheindex}\end{sphinxtheindex}} +''', } latex_show_urls = 'footnote' latex_use_xindy = True diff --git a/doc/latex.rst b/doc/latex.rst index 6118fdee6..cfd6f7d8b 100644 --- a/doc/latex.rst +++ b/doc/latex.rst @@ -55,7 +55,7 @@ example:: \setlength{\cftsecnumwidth}{1.25cm} ''', 'fncychap': r'\usepackage[Bjornstrup]{fncychap}', - 'printindex': r'\footnotesize\raggedright\sphinxprintindex', + 'printindex': r'\footnotesize\raggedright\printindex', } latex_show_urls = 'footnote' @@ -399,23 +399,6 @@ Macros :file:`sphinxmanual.cls` and :file:`sphinxhowto.cls`. - the citation reference is typeset via ``\sphinxcite`` which is a wrapper of standard ``\cite``. -- regarding the general index, the :confval:`latex_elements` dictionary has a - ``'printindex'`` key which defaults to ``'\\sphinxprintindex'``. It often - proves advantageous to use:: - - 'printindex': '\\footnotesize\\raggedright\\sphinxprintindex', - - especially if the index contains long entries. The LaTeX class for Japanese - ``'manual'``-type documents already does the font size and text - justification change, so the above is not needed then. - - .. tip:: - - Advanced LaTeX users can also, via :confval:`latex_additional_files`, use - a custom :program:`makeindex` style file :file:`python.ist`, or a custom - :program:`xindy` style file :file:`sphinx.xdy` (see - :confval:`latex_use_xindy`) in order to modify how the general index is - typeset. Environments ~~~~~~~~~~~~ @@ -470,8 +453,7 @@ Environments - the bibliography uses ``sphinxthebibliography`` and the Python Module index as well as the general index both use ``sphinxtheindex``; these environments are wrappers of the ``thebibliography`` and respectively ``theindex`` - environments, needed mainly to insert a corresponding entry in the PDF - bookmarks and table of contents. + environments as provided by the document class (or packages). .. versionchanged:: 1.5 formerly, the original environments were modified by Sphinx. diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 99f5ddc91..a524a221f 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1763,8 +1763,8 @@ the `Dublin Core metadata `_. Options for LaTeX output ------------------------ -These options influence LaTeX output. For customization of LaTeX -macros and environments, see also :doc:`/latex`. +These options influence LaTeX output. Refer to :doc:`/latex` for more +information. .. confval:: latex_engine @@ -2182,14 +2182,11 @@ macros and environments, see also :doc:`/latex`. Remove unneeded ``{}`` after ``\\hrule``. ``'printindex'`` - "printindex" call, the last thing in the file. - - .. versionchanged:: 1.8 - Former default ``'\\printindex'`` now ``'\\sphinxprintindex'``. - This macro works around an issue__ with PDF builds at RTD doing too - few ``pdflatex`` runs. - - __ https://github.com/rtfd/readthedocs.org/issues/2857 + "printindex" call, the last thing in the file, default + ``'\\printindex'``. Override if you want to generate the index + differently or append some content after the index. For example + ``'\\footnotesize\\raggedright\\printindex'`` is advisable when the + index is full of long entries. ``'fvset'`` Customization of ``fancyvrb`` LaTeX package. Defaults to diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index a677be3b7..fc75bf316 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -462,14 +462,6 @@ } \fi -% provide \sphinxprintindex as variant of \printindex designed to workaround -% rtfd/readthedocs.org#2857 regarding "Index" entry in PDF bookmarks -\newcommand*{\sphinxprintindex}{% - \IfFileExists{\jobname.ind} - {\printindex} - {\begin{sphinxtheindex}\end{sphinxtheindex}}% -}% - % make commands known to non-Sphinx document classes \providecommand*{\sphinxtableofcontents}{\tableofcontents} \ltx@ifundefined{sphinxthebibliography} diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index a2b240f06..bf2215a51 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -124,7 +124,7 @@ DEFAULT_SETTINGS = { 'maketitle': '\\maketitle', 'tableofcontents': '\\sphinxtableofcontents', 'atendofbody': '', - 'printindex': '\\sphinxprintindex', + 'printindex': '\\printindex', 'transition': '\n\n\\bigskip\\hrule\\bigskip\n\n', 'figure_align': 'htbp', 'tocdepth': '', From e726073c87d4d3852d4dcb0bc2a745138e708378 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 12:27:35 +0200 Subject: [PATCH 074/174] Let Latexmk check if idx file is empty before xindy call Fix: #5240 --- sphinx/texinputs/latexmkrc_t | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/texinputs/latexmkrc_t b/sphinx/texinputs/latexmkrc_t index d52681fbd..fba2f292e 100644 --- a/sphinx/texinputs/latexmkrc_t +++ b/sphinx/texinputs/latexmkrc_t @@ -11,7 +11,7 @@ $pdflatex = 'xelatex ' . $ENV{'LATEXOPTS'} . ' %O %S'; $lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S'; $xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S'; {% if xindy_use -%} -$makeindex = 'xindy ' . $ENV{'XINDYOPTS'} . ' %O -o %D %S'; +$makeindex = '[ ! -s %S ] && : > %D || xindy ' . $ENV{'XINDYOPTS'} . ' %O -o %D %S'; {% else -%} $makeindex = 'makeindex -s python.ist %O -o %D %S'; {% endif -%} From b8f43e56aea931478947b2cfaf8cbf21f37935ae Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 16:54:25 +0200 Subject: [PATCH 075/174] Update latex docs --- doc/usage/configuration.rst | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 99f5ddc91..1d0f30caf 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2005,14 +2005,6 @@ macros and environments, see also :doc:`/latex`. Font package inclusion, default ``'\\usepackage{times}'`` (which uses Times for text, Helvetica for sans serif and Courier for code-blocks). - .. hint:: - - Courier is much wider than Times, and Sphinx emits LaTeX command - ``\small`` in code-blocks to compensate. Since ``1.5`` this is not - hard-coded anymore: ``\fvset{fontsize=auto}`` can be added to - preamble to not change font size in code-blocks. Since ``1.8`` a - separate ``'fvset'`` key is provided for this. - .. versionchanged:: 1.2 Defaults to ``''`` when the :confval:`language` uses the Cyrillic script. @@ -2020,8 +2012,7 @@ macros and environments, see also :doc:`/latex`. Defaults to ``''`` when :confval:`latex_engine` is ``'xelatex'``. .. versionchanged:: 1.6 Defaults to ``''`` also with ``'lualatex'``. - .. versionchanged:: 1.8 - ``'xelatex'`` and ``'lualatex'`` do ``\fvset{fontsize=auto}``. + ``'fncychap'`` Inclusion of the "fncychap" package (which makes fancy chapter titles), default ``'\\usepackage[Bjarne]{fncychap}'`` for English documentation @@ -2192,13 +2183,18 @@ macros and environments, see also :doc:`/latex`. __ https://github.com/rtfd/readthedocs.org/issues/2857 ``'fvset'`` - Customization of ``fancyvrb`` LaTeX package. Defaults to - ``'\\fvset{fontsize=\\small}'``, because default font (Courier) used in - code-blocks is wider and taller than default text font (Times). + Customization of ``fancyvrb`` LaTeX package. Currently, Sphinx uses + this key to set the fontsize in code-blocks according to the + :confval:`latex_engine`. - For ``'xelatex'`` and ``'lualatex'``, defaults to - ``'\\fvset{fontsize=auto}'``, because the default fonts are part of - one unified typeface family (Latin Modern OpenType). + - ``'pdflatex'`` uses ``'fvvset': '\\fvset{fontsize=\\small}'``, + to mitigate the size difference between the default monospaced font + (Courier) and the default text font (Times). You may need to modify + this if you use custom fonts. + + - ``'xelatex'`` and ``'lualatex'`` use ``'\\fvset{fontsize=auto}'``, + as there is no size difference between the regular and the + monospaced fonts used by default by Sphinx. .. versionadded:: 1.8 From d07103fde2a440a6a5d9e991f604006bfb72315a Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 17:11:59 +0200 Subject: [PATCH 076/174] Fix typo in updated docs --- doc/usage/configuration.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 1d0f30caf..89381f6b8 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2187,14 +2187,14 @@ macros and environments, see also :doc:`/latex`. this key to set the fontsize in code-blocks according to the :confval:`latex_engine`. - - ``'pdflatex'`` uses ``'fvvset': '\\fvset{fontsize=\\small}'``, + - ``'pdflatex'`` uses ``'fvset': '\\fvset{fontsize=\\small}'``, to mitigate the size difference between the default monospaced font (Courier) and the default text font (Times). You may need to modify this if you use custom fonts. - ``'xelatex'`` and ``'lualatex'`` use ``'\\fvset{fontsize=auto}'``, as there is no size difference between the regular and the - monospaced fonts used by default by Sphinx. + monospaced fonts used by default by Sphinx with these engines. .. versionadded:: 1.8 From 80b320c9ae8503c388d5d05a9a09d7cb39a30a07 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 1 Aug 2018 00:35:44 +0900 Subject: [PATCH 077/174] latex: Reorder deprected method --- sphinx/writers/latex.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index a2b240f06..17778107a 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -739,13 +739,6 @@ class LaTeXTranslator(nodes.NodeVisitor): footnode.walkabout(self) self.pending_footnotes = [] - @property - def footnotestack(self): - # type: () -> List[Dict[unicode, List[Union[collected_footnote, bool]]]] - warnings.warn('LaTeXWriter.footnotestack is deprecated.', - RemovedInSphinx30Warning) - return [] - def format_docclass(self, docclass): # type: (unicode) -> unicode """ prepends prefix to sphinx document classes @@ -2566,6 +2559,13 @@ class LaTeXTranslator(nodes.NodeVisitor): # --------- METHODS FOR COMPATIBILITY -------------------------------------- + @property + def footnotestack(self): + # type: () -> List[Dict[unicode, List[Union[collected_footnote, bool]]]] + warnings.warn('LaTeXWriter.footnotestack is deprecated.', + RemovedInSphinx30Warning) + return [] + @property def bibitems(self): # type: () -> List[List[unicode]] From 077e9afd29929aa1892bc4fb547284c094a5fe24 Mon Sep 17 00:00:00 2001 From: jfbu Date: Thu, 26 Jul 2018 19:20:45 +0200 Subject: [PATCH 078/174] LaTeX: fix usage of PAPER envvar, which got broken at Sphinx 1.5 Fix: #5234 --- doc/man/sphinx-build.rst | 11 ++++++++++- sphinx/make_mode.py | 2 +- sphinx/templates/quickstart/Makefile_t | 4 ++-- sphinx/templates/quickstart/make.bat_t | 4 ++-- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/doc/man/sphinx-build.rst b/doc/man/sphinx-build.rst index fdd0d36c2..3d9ee579d 100644 --- a/doc/man/sphinx-build.rst +++ b/doc/man/sphinx-build.rst @@ -273,7 +273,16 @@ variables to customize behavior: .. describe:: PAPER - The value for '"papersize"` key of :confval:`latex_elements`. + This sets the ``'papersize'`` key of :confval:`latex_elements`: + i.e. ``PAPER=a4`` sets it to ``'a4paper'`` and ``PAPER=letter`` to + ``'letterpaper'``. + + .. note:: + + Usage of this environment variable got broken at Sphinx 1.5 as + ``a4`` or ``letter`` ended up as option to LaTeX document in + place of the needed ``a4paper``, resp. ``letterpaper``. Fixed at + 1.7.7. .. describe:: SPHINXBUILD diff --git a/sphinx/make_mode.py b/sphinx/make_mode.py index aecad31b4..f71448ef2 100644 --- a/sphinx/make_mode.py +++ b/sphinx/make_mode.py @@ -143,7 +143,7 @@ class Make(object): papersize = os.getenv('PAPER', '') opts = self.opts if papersize in ('a4', 'letter'): - opts.extend(['-D', 'latex_elements.papersize=' + papersize]) + opts.extend(['-D', 'latex_elements.papersize=' + papersize + 'paper']) if doctreedir is None: doctreedir = self.builddir_join('doctrees') diff --git a/sphinx/templates/quickstart/Makefile_t b/sphinx/templates/quickstart/Makefile_t index bf752404e..3af40947c 100644 --- a/sphinx/templates/quickstart/Makefile_t +++ b/sphinx/templates/quickstart/Makefile_t @@ -9,8 +9,8 @@ SOURCEDIR = {{ rsrcdir }} BUILDDIR = {{ rbuilddir }} # Internal variables. -PAPEROPT_a4 = -D latex_elements.papersize=a4 -PAPEROPT_letter = -D latex_elements.papersize=letter +PAPEROPT_a4 = -D latex_elements.papersize=a4paper +PAPEROPT_letter = -D latex_elements.papersize=letterpaper # $(O) is meant as a shortcut for $(SPHINXOPTS) ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(O) $(SOURCEDIR) # the i18n builder cannot share the environment and doctrees with the others diff --git a/sphinx/templates/quickstart/make.bat_t b/sphinx/templates/quickstart/make.bat_t index 6e8665a49..cd96c0736 100644 --- a/sphinx/templates/quickstart/make.bat_t +++ b/sphinx/templates/quickstart/make.bat_t @@ -12,8 +12,8 @@ set SOURCEDIR={{ rsrcdir }} set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% %SOURCEDIR% set I18NSPHINXOPTS=%SPHINXOPTS% %SOURCEDIR% if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_elements.papersize=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_elements.papersize=%PAPER% %I18NSPHINXOPTS% + set ALLSPHINXOPTS=-D latex_elements.papersize=%PAPER%paper %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_elements.papersize=%PAPER%paper %I18NSPHINXOPTS% ) if "%1" == "" goto help From 69f21c144c18a554a0123f14a9edd191e8377807 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 19:11:04 +0200 Subject: [PATCH 079/174] Update CHANGES for PR #5235 --- CHANGES | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGES b/CHANGES index c22aefad5..d24322385 100644 --- a/CHANGES +++ b/CHANGES @@ -22,6 +22,8 @@ Bugs fixed console output (refs: #5236) * LaTeX: suppress "remreset Warning: The remreset package is obsolete" in latex console output with recent LaTeX (refs: #5237) +* #5234: PDF output: usage of PAPER environment variable is broken since Sphinx + 1.5 Testing -------- From a281cdaf3590271d140cdd098460dde12c823b71 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 19:16:37 +0200 Subject: [PATCH 080/174] Update CHANGES for PR #5239 --- CHANGES | 5 ----- 1 file changed, 5 deletions(-) diff --git a/CHANGES b/CHANGES index b2bc9ead4..e5a643779 100644 --- a/CHANGES +++ b/CHANGES @@ -172,11 +172,6 @@ Features added for mathjax * #4362: latex: Don't overwrite .tex file if document not changed * #1431: latex: Add alphanumeric enumerated list support -* Extend to all projects not using the Sphinx LaTeX Makefile a workaround for - `issue rtfd/readthedocs.org#2857`__ about insufficient number of - ``pdflatex`` runs for index to show up in PDF bookmarks (refs: #3742) - - __ https://github.com/rtfd/readthedocs.org/issues/2857 * Add :confval:`latex_use_xindy` for UTF-8 savvy indexing, defaults to ``True`` if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter From 2dd35f6907e6470bb5fa32bea97d2d61c0e572b8 Mon Sep 17 00:00:00 2001 From: jfbu Date: Tue, 31 Jul 2018 19:24:51 +0200 Subject: [PATCH 081/174] Update CHANGES --- CHANGES | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index e5a643779..ea076e974 100644 --- a/CHANGES +++ b/CHANGES @@ -173,7 +173,8 @@ Features added * #4362: latex: Don't overwrite .tex file if document not changed * #1431: latex: Add alphanumeric enumerated list support * Add :confval:`latex_use_xindy` for UTF-8 savvy indexing, defaults to ``True`` - if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. + if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. (refs: #5134, + #5192, #5212) * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter * #5122: setuptools: support nitpicky option * #2820: autoclass directive supports nested class From ee87338b0bd13cc17c9c42041413be56d43cb7a8 Mon Sep 17 00:00:00 2001 From: jfbu Date: Wed, 1 Aug 2018 11:57:53 +0200 Subject: [PATCH 082/174] LaTeX: streamline ``\DeclareUnicodeCharacter`` usage --- sphinx/writers/latex.py | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index bf2215a51..3973fcdae 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -137,21 +137,22 @@ ADDITIONAL_SETTINGS = { 'pdflatex': { 'inputenc': '\\usepackage[utf8]{inputenc}', 'utf8extra': ('\\ifdefined\\DeclareUnicodeCharacter\n' - ' \\ifdefined\\DeclareUnicodeCharacterAsOptional\n' - ' \\DeclareUnicodeCharacter{"00A0}{\\nobreakspace}\n' - ' \\DeclareUnicodeCharacter{"2500}{\\sphinxunichar{2500}}\n' - ' \\DeclareUnicodeCharacter{"2502}{\\sphinxunichar{2502}}\n' - ' \\DeclareUnicodeCharacter{"2514}{\\sphinxunichar{2514}}\n' - ' \\DeclareUnicodeCharacter{"251C}{\\sphinxunichar{251C}}\n' - ' \\DeclareUnicodeCharacter{"2572}{\\textbackslash}\n' - ' \\else\n' - ' \\DeclareUnicodeCharacter{00A0}{\\nobreakspace}\n' - ' \\DeclareUnicodeCharacter{2500}{\\sphinxunichar{2500}}\n' - ' \\DeclareUnicodeCharacter{2502}{\\sphinxunichar{2502}}\n' - ' \\DeclareUnicodeCharacter{2514}{\\sphinxunichar{2514}}\n' - ' \\DeclareUnicodeCharacter{251C}{\\sphinxunichar{251C}}\n' - ' \\DeclareUnicodeCharacter{2572}{\\textbackslash}\n' - ' \\fi\n' + '% support both utf8 and utf8x syntaxes\n' + '\\edef\\sphinxdqmaybe{' + '\\ifdefined\\DeclareUnicodeCharacterAsOptional' + '\\string"\\fi}\n' + ' \\DeclareUnicodeCharacter{\\sphinxdqmaybe00A0}' + '{\\nobreakspace}\n' + ' \\DeclareUnicodeCharacter{\\sphinxdqmaybe2500}' + '{\\sphinxunichar{2500}}\n' + ' \\DeclareUnicodeCharacter{\\sphinxdqmaybe2502}' + '{\\sphinxunichar{2502}}\n' + ' \\DeclareUnicodeCharacter{\\sphinxdqmaybe2514}' + '{\\sphinxunichar{2514}}\n' + ' \\DeclareUnicodeCharacter{\\sphinxdqmaybe251C}' + '{\\sphinxunichar{251C}}\n' + ' \\DeclareUnicodeCharacter{\\sphinxdqmaybe2572}' + '{\\textbackslash}\n' '\\fi'), }, 'xelatex': { From 25bfa1692a3e1d2ca6e4f0fdca8c4c399cc198d8 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 31 May 2018 18:19:01 +0900 Subject: [PATCH 083/174] refactor: Move repository of changesets to domain from env --- CHANGES | 2 + doc/extdev/index.rst | 10 ++++ sphinx/application.py | 1 + sphinx/builders/changes.py | 34 +++++++------ sphinx/directives/other.py | 4 +- sphinx/domains/changeset.py | 88 ++++++++++++++++++++++++++++++++++ sphinx/environment/__init__.py | 36 +++++++------- 7 files changed, 140 insertions(+), 35 deletions(-) create mode 100644 sphinx/domains/changeset.py diff --git a/CHANGES b/CHANGES index b2bc9ead4..c64933bae 100644 --- a/CHANGES +++ b/CHANGES @@ -84,9 +84,11 @@ Deprecated * ``env._read_parallel()`` is deprecated * ``env.write_doctree()`` is deprecated * ``env._nitpick_ignore`` is deprecated +* ``env.versionchanges`` is deprecated * ``env.dump()`` is deprecated * ``env.dumps()`` is deprecated * ``env.topickle()`` is deprecated +* ``env.note_versionchange()`` is deprecated * ``sphinx.writers.latex.Table.caption_footnotetexts`` is deprecated * ``sphinx.writers.latex.Table.header_footnotetexts`` is deprecated * ``sphinx.writers.latex.LaTeXTranslator.footnotestack`` is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 55f7fb827..f6f1b8fd0 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -385,6 +385,11 @@ The following is a list of deprecated interface. - 3.0 - :confval:`nitpick_ignore` + * - ``BuildEnvironment.versionchanges`` + - 1.8 + - 3.0 + - N/A + * - ``BuildEnvironment.update()`` - 1.8 - 3.0 @@ -410,6 +415,11 @@ The following is a list of deprecated interface. - 3.0 - ``Builder.write_doctree()`` + * - ``BuildEnvironment.note_versionchange()`` + - 1.8 + - 3.0 + - ``ChangesDomain.note_changeset()`` + * - ``warn()`` (template helper function) - 1.8 - 3.0 diff --git a/sphinx/application.py b/sphinx/application.py index 5c6bfc52e..adca8acb4 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -80,6 +80,7 @@ builtin_extensions = ( 'sphinx.builders.xml', 'sphinx.config', 'sphinx.domains.c', + 'sphinx.domains.changeset', 'sphinx.domains.cpp', 'sphinx.domains.javascript', 'sphinx.domains.math', diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 011aa6ebe..3f9bffa0d 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -11,11 +11,13 @@ import codecs from os import path +from typing import cast from six import iteritems from sphinx import package_dir from sphinx.builders import Builder +from sphinx.domains.changeset import ChangeSetDomain from sphinx.locale import _, __ from sphinx.theming import HTMLThemeFactory from sphinx.util import logging @@ -60,6 +62,7 @@ class ChangesBuilder(Builder): def write(self, *ignored): # type: (Any) -> None version = self.config.version + domain = cast(ChangeSetDomain, self.env.get_domain('changeset')) libchanges = {} # type: Dict[unicode, List[Tuple[unicode, unicode, int]]] apichanges = [] # type: List[Tuple[unicode, unicode, int]] otherchanges = {} # type: Dict[Tuple[unicode, unicode], List[Tuple[unicode, unicode, int]]] # NOQA @@ -67,21 +70,22 @@ class ChangesBuilder(Builder): logger.info(bold(__('no changes in version %s.') % version)) return logger.info(bold('writing summary file...')) - for type, docname, lineno, module, descname, content in \ - self.env.versionchanges[version]: - if isinstance(descname, tuple): - descname = descname[0] - ttext = self.typemap[type] - context = content.replace('\n', ' ') - if descname and docname.startswith('c-api'): + for changeset in domain.get_changesets_for(version): + if isinstance(changeset.descname, tuple): + descname = changeset.descname[0] + else: + descname = changeset.descname + ttext = self.typemap[changeset.type] + context = changeset.content.replace('\n', ' ') + if descname and changeset.docname.startswith('c-api'): if context: entry = '%s: %s: %s' % (descname, ttext, context) else: entry = '%s: %s.' % (descname, ttext) - apichanges.append((entry, docname, lineno)) - elif descname or module: - if not module: + apichanges.append((entry, changeset.docname, changeset.lineno)) + elif descname or changeset.module: + if not changeset.module: module = _('Builtins') if not descname: descname = _('Module level') @@ -90,15 +94,15 @@ class ChangesBuilder(Builder): context) else: entry = '%s: %s.' % (descname, ttext) - libchanges.setdefault(module, []).append((entry, docname, - lineno)) + libchanges.setdefault(module, []).append((entry, changeset.docname, + changeset.lineno)) else: if not context: continue entry = '%s: %s' % (ttext.capitalize(), context) - title = self.env.titles[docname].astext() - otherchanges.setdefault((docname, title), []).append( - (entry, docname, lineno)) + title = self.env.titles[changeset.docname].astext() + otherchanges.setdefault((changeset.docname, title), []).append( + (entry, changeset.docname, changeset.lineno)) ctx = { 'project': self.config.project, diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index c6c82ff43..07da5ee6e 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -261,8 +261,8 @@ class VersionChange(SphinxDirective): classes=['versionmodified']), translatable=False) node.append(para) - # XXX should record node.source as well - self.env.note_versionchange(node['type'], node['version'], node, node.line) + + self.env.get_domain('changeset').note_changeset(node) # type: ignore return [node] + messages diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py new file mode 100644 index 000000000..8e62cb735 --- /dev/null +++ b/sphinx/domains/changeset.py @@ -0,0 +1,88 @@ +# -*- coding: utf-8 -*- +""" + sphinx.domains.changeset + ~~~~~~~~~~~~~~~~~~~~~~~~ + + The changeset domain. + + :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + +from typing import NamedTuple + +from six import iteritems + +from sphinx.domains import Domain + + +if False: + # For type annotation + from typing import Any, Dict, List # NOQA + from docutils import nodes # NOQA + from sphinx.application import Sphinx # NOQA + from sphinx.environment import BuildEnvironment # NOQA + + +ChangeSet = NamedTuple('ChangeSet', [('type', str), + ('docname', str), + ('lineno', int), + ('module', str), + ('descname', str), + ('content', str)]) + + +class ChangeSetDomain(Domain): + """Domain for changesets.""" + + name = 'changeset' + label = 'changeset' + + initial_data = { + 'changes': {}, # version -> list of ChangeSet + } # type: Dict + + def clear_doc(self, docname): + # type: (unicode) -> None + for version, changes in iteritems(self.data['changes']): + for changeset in changes[:]: + if changeset.docname == docname: + changes.remove(changeset) + + def merge_domaindata(self, docnames, otherdata): + # type: (List[unicode], Dict) -> None + # XXX duplicates? + for version, otherchanges in iteritems(otherdata['changes']): + changes = self.data['changes'].setdefault(version, []) + for changeset in otherchanges: + if changeset.docname in docnames: + changes.append(changeset) + + def process_doc(self, env, docname, document): + # type: (BuildEnvironment, unicode, nodes.Node) -> None + pass # nothing to do here. All changesets are registered on calling directive. + + def note_changeset(self, node): + # type: (nodes.Node) -> None + version = node['version'] + module = self.env.ref_context.get('py:module') + objname = self.env.temp_data.get('object') + changeset = ChangeSet(node['type'], self.env.docname, node.line, # type: ignore + module, objname, node.astext()) + self.data['changes'].setdefault(version, []).append(changeset) + + def get_changesets_for(self, version): + # type: (unicode) -> List[ChangeSet] + return self.data['changes'].get(version, []) + + +def setup(app): + # type: (Sphinx) -> Dict[unicode, Any] + app.add_domain(ChangeSetDomain) + + return { + 'version': 'builtin', + 'env_version': 1, + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index 20ff9e336..6a44e16d5 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -186,9 +186,6 @@ class BuildEnvironment(object): self.indexentries = {} # type: Dict[unicode, List[Tuple[unicode, unicode, unicode, unicode, unicode]]] # NOQA # docname -> list of # (type, unicode, target, aliasname) - self.versionchanges = {} # type: Dict[unicode, List[Tuple[unicode, unicode, int, unicode, unicode, unicode]]] # NOQA - # version -> list of (type, docname, - # lineno, module, descname, content) # these map absolute path -> (docnames, unique filename) self.images = FilenameUniqDict() # type: FilenameUniqDict @@ -321,10 +318,6 @@ class BuildEnvironment(object): self.reread_always.discard(docname) self.included.discard(docname) - for version, changes in self.versionchanges.items(): - new = [change for change in changes if change[1] != docname] - changes[:] = new - for domain in self.domains.values(): domain.clear_doc(docname) @@ -343,10 +336,6 @@ class BuildEnvironment(object): if docname in other.included: self.included.add(docname) - for version, changes in other.versionchanges.items(): - self.versionchanges.setdefault(version, []).extend( - change for change in changes if change[1] in docnames) - for domainname, domain in self.domains.items(): domain.merge_domaindata(docnames, other.domaindata[domainname]) app.emit('env-merge-info', self, docnames, other) @@ -571,13 +560,6 @@ class BuildEnvironment(object): """ self.reread_always.add(self.docname) - def note_versionchange(self, type, version, node, lineno): - # type: (unicode, unicode, nodes.Node, int) -> None - self.versionchanges.setdefault(version, []).append( - (type, self.temp_data['docname'], lineno, - self.ref_context.get('py:module'), - self.temp_data.get('object'), node.astext())) - def note_toctree(self, docname, toctreenode): # type: (unicode, addnodes.toctree) -> None """Note a TOC tree directive in a document and gather information about @@ -857,3 +839,21 @@ class BuildEnvironment(object): RemovedInSphinx30Warning) with open(filename, 'wb') as f: self.dump(self, f) + + @property + def versionchanges(self): + # type: () -> Dict[unicode, List[Tuple[unicode, unicode, int, unicode, unicode, unicode]]] # NOQA + warnings.warn('env.versionchanges() is deprecated. ' + 'Please use ChangeSetDomain instead.', + RemovedInSphinx30Warning) + return self.domaindata['changeset']['changes'] + + def note_versionchange(self, type, version, node, lineno): + # type: (unicode, unicode, nodes.Node, int) -> None + warnings.warn('env.note_versionchange() is deprecated. ' + 'Please use ChangeSetDomain.note_changeset() instead.', + RemovedInSphinx30Warning) + node['type'] = type + node['version'] = version + node.line = lineno + self.get_domain('changeset').note_changeset(node) # type: ignore From 03d083e7840832058c0f3b3b837aa027ca897493 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 2 Aug 2018 01:22:11 +0900 Subject: [PATCH 084/174] Move VersionChanges directive to sphinx.domains.changeset --- CHANGES | 1 + doc/extdev/index.rst | 5 +++ sphinx/directives/other.py | 68 +--------------------------------- sphinx/domains/changeset.py | 73 ++++++++++++++++++++++++++++++++++++- 4 files changed, 80 insertions(+), 67 deletions(-) diff --git a/CHANGES b/CHANGES index c64933bae..0bca9f188 100644 --- a/CHANGES +++ b/CHANGES @@ -118,6 +118,7 @@ Deprecated * ``sphinx.ext.mathbase.is_in_section_title()`` is deprecated * ``sphinx.ext.mathbase.MathDomain`` is deprecated * ``sphinx.ext.mathbase.setup_math()`` is deprecated +* ``sphinx.directives.other.VersionChanges`` is deprecated * ``sphinx.highlighting.PygmentsBridge.unhighlight()`` is deprecated * ``sphinx.ext.mathbase.get_node_equation_number()`` is deprecated * ``sphinx.ext.mathbase.wrap_displaymath()`` is deprecated diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index f6f1b8fd0..0fa4db260 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -131,6 +131,11 @@ The following is a list of deprecated interface. - 4.0 - :meth:`~sphinx.application.Sphinx.add_js_file()` + * - ``sphinx.directives.other.VersionChanges`` + - 1.8 + - 3.0 + - ``sphinx.domains.changeset.VersionChanges`` + * - ``sphinx.highlighting.PygmentsBridge.unhighlight()`` - 1.8 - 3.0 diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index 07da5ee6e..2e44feb95 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -17,8 +17,8 @@ from docutils.parsers.rst.directives.misc import Class from docutils.parsers.rst.directives.misc import Include as BaseInclude from six.moves import range -from sphinx import addnodes, locale -from sphinx.deprecation import DeprecatedDict, RemovedInSphinx30Warning +from sphinx import addnodes +from sphinx.domains.changeset import VersionChange # NOQA # for compatibility from sphinx.locale import _ from sphinx.util import url_re, docname_join from sphinx.util.docutils import SphinxDirective @@ -32,19 +32,6 @@ if False: from sphinx.application import Sphinx # NOQA -versionlabels = { - 'versionadded': _('New in version %s'), - 'versionchanged': _('Changed in version %s'), - 'deprecated': _('Deprecated since version %s'), -} # type: Dict[unicode, unicode] - -locale.versionlabels = DeprecatedDict( - versionlabels, - 'sphinx.locale.versionlabels is deprecated. ' - 'Please use sphinx.directives.other.versionlabels instead.', - RemovedInSphinx30Warning -) - glob_re = re.compile(r'.*[*?\[].*') @@ -218,54 +205,6 @@ class Index(SphinxDirective): return [indexnode, targetnode] -class VersionChange(SphinxDirective): - """ - Directive to describe a change/addition/deprecation in a specific version. - """ - has_content = True - required_arguments = 1 - optional_arguments = 1 - final_argument_whitespace = True - option_spec = {} # type: Dict - - def run(self): - # type: () -> List[nodes.Node] - node = addnodes.versionmodified() - node.document = self.state.document - set_source_info(self, node) - node['type'] = self.name - node['version'] = self.arguments[0] - text = versionlabels[self.name] % self.arguments[0] - if len(self.arguments) == 2: - inodes, messages = self.state.inline_text(self.arguments[1], - self.lineno + 1) - para = nodes.paragraph(self.arguments[1], '', *inodes, translatable=False) - set_source_info(self, para) - node.append(para) - else: - messages = [] - if self.content: - self.state.nested_parse(self.content, self.content_offset, node) - if len(node): - if isinstance(node[0], nodes.paragraph) and node[0].rawsource: - content = nodes.inline(node[0].rawsource, translatable=True) - content.source = node[0].source - content.line = node[0].line - content += node[0].children - node[0].replace_self(nodes.paragraph('', '', content, translatable=False)) - node[0].insert(0, nodes.inline('', '%s: ' % text, - classes=['versionmodified'])) - else: - para = nodes.paragraph('', '', - nodes.inline('', '%s.' % text, - classes=['versionmodified']), - translatable=False) - node.append(para) - - self.env.get_domain('changeset').note_changeset(node) # type: ignore - return [node] + messages - - class SeeAlso(BaseAdmonition): """ An admonition mentioning things to look at as reference. @@ -475,9 +414,6 @@ def setup(app): directives.register_directive('moduleauthor', Author) directives.register_directive('codeauthor', Author) directives.register_directive('index', Index) - directives.register_directive('deprecated', VersionChange) - directives.register_directive('versionadded', VersionChange) - directives.register_directive('versionchanged', VersionChange) directives.register_directive('seealso', SeeAlso) directives.register_directive('tabularcolumns', TabularColumns) directives.register_directive('centered', Centered) diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index 8e62cb735..ed878b1d3 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -11,19 +11,39 @@ from typing import NamedTuple +from docutils import nodes from six import iteritems +from sphinx import addnodes +from sphinx import locale +from sphinx.deprecation import DeprecatedDict, RemovedInSphinx30Warning from sphinx.domains import Domain +from sphinx.locale import _ +from sphinx.util.docutils import SphinxDirective +from sphinx.util.nodes import set_source_info if False: # For type annotation from typing import Any, Dict, List # NOQA - from docutils import nodes # NOQA from sphinx.application import Sphinx # NOQA from sphinx.environment import BuildEnvironment # NOQA +versionlabels = { + 'versionadded': _('New in version %s'), + 'versionchanged': _('Changed in version %s'), + 'deprecated': _('Deprecated since version %s'), +} # type: Dict[unicode, unicode] + +locale.versionlabels = DeprecatedDict( + versionlabels, + 'sphinx.locale.versionlabels is deprecated. ' + 'Please use sphinx.domains.changeset.versionlabels instead.', + RemovedInSphinx30Warning +) + + ChangeSet = NamedTuple('ChangeSet', [('type', str), ('docname', str), ('lineno', int), @@ -32,6 +52,54 @@ ChangeSet = NamedTuple('ChangeSet', [('type', str), ('content', str)]) +class VersionChange(SphinxDirective): + """ + Directive to describe a change/addition/deprecation in a specific version. + """ + has_content = True + required_arguments = 1 + optional_arguments = 1 + final_argument_whitespace = True + option_spec = {} # type: Dict + + def run(self): + # type: () -> List[nodes.Node] + node = addnodes.versionmodified() + node.document = self.state.document + set_source_info(self, node) + node['type'] = self.name + node['version'] = self.arguments[0] + text = versionlabels[self.name] % self.arguments[0] + if len(self.arguments) == 2: + inodes, messages = self.state.inline_text(self.arguments[1], + self.lineno + 1) + para = nodes.paragraph(self.arguments[1], '', *inodes, translatable=False) + set_source_info(self, para) + node.append(para) + else: + messages = [] + if self.content: + self.state.nested_parse(self.content, self.content_offset, node) + if len(node): + if isinstance(node[0], nodes.paragraph) and node[0].rawsource: + content = nodes.inline(node[0].rawsource, translatable=True) + content.source = node[0].source + content.line = node[0].line + content += node[0].children + node[0].replace_self(nodes.paragraph('', '', content, translatable=False)) + node[0].insert(0, nodes.inline('', '%s: ' % text, + classes=['versionmodified'])) + else: + para = nodes.paragraph('', '', + nodes.inline('', '%s.' % text, + classes=['versionmodified']), + translatable=False) + node.append(para) + + self.env.get_domain('changeset').note_changeset(node) # type: ignore + return [node] + messages + + class ChangeSetDomain(Domain): """Domain for changesets.""" @@ -79,6 +147,9 @@ class ChangeSetDomain(Domain): def setup(app): # type: (Sphinx) -> Dict[unicode, Any] app.add_domain(ChangeSetDomain) + app.add_directive('deprecated', VersionChange) + app.add_directive('versionadded', VersionChange) + app.add_directive('versionchanged', VersionChange) return { 'version': 'builtin', From 8e56f8638314e0a2332af886f825e6fd5598dc15 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 28 Jul 2018 19:54:56 +0900 Subject: [PATCH 085/174] Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`) --- CHANGES | 1 + doc/usage/restructuredtext/domains.rst | 19 +++++++++++++++++++ doc/usage/restructuredtext/roles.rst | 8 +------- sphinx/builders/latex/transforms.py | 2 +- sphinx/domains/math.py | 8 ++++++-- tests/roots/test-ext-math/math.rst | 2 +- tests/test_ext_math.py | 10 +++++++--- 7 files changed, 36 insertions(+), 14 deletions(-) diff --git a/CHANGES b/CHANGES index b2bc9ead4..cdd6fa73d 100644 --- a/CHANGES +++ b/CHANGES @@ -186,6 +186,7 @@ Features added * Apply :confval:`trim_doctest_flags` to all builders (cf. text, manpages) * #5140: linkcheck: Add better Accept header to HTTP client * #4614: sphinx-build: Add ``--keep-going`` option to show all warnings +* Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`) Bugs fixed ---------- diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst index c5b58c7d4..95d31f6ce 100644 --- a/doc/usage/restructuredtext/domains.rst +++ b/doc/usage/restructuredtext/domains.rst @@ -1325,6 +1325,25 @@ These roles are provided to refer to the described objects: .. rst:role:: rst:dir rst:role +.. _math-domain: + +The Math Domain +--------------- + +The math domain (name **math**) provides the following roles:: + +.. rst:role:: math:numref + + Role for cross-referencing equations defined by :rst:dir:`math` directive + via their label. Example:: + + .. math:: e^{i\pi} + 1 = 0 + :label: euler + + Euler's identity, equation :math:numref:`euler`, was elected one of the + most beautiful mathematical formulas. + + .. versionadded:: 1.8 More domains ------------ diff --git a/doc/usage/restructuredtext/roles.rst b/doc/usage/restructuredtext/roles.rst index 6e819aa68..637df711b 100644 --- a/doc/usage/restructuredtext/roles.rst +++ b/doc/usage/restructuredtext/roles.rst @@ -288,13 +288,7 @@ Math .. rst:role:: eq - Role for cross-referencing equations via their label. Example:: - - .. math:: e^{i\pi} + 1 = 0 - :label: euler - - Euler's identity, equation :eq:`euler`, was elected one of the most - beautiful mathematical formulas. + Same as :rst:role:`math:numref`. Other semantic markup diff --git a/sphinx/builders/latex/transforms.py b/sphinx/builders/latex/transforms.py index e3cfb2121..160c8c324 100644 --- a/sphinx/builders/latex/transforms.py +++ b/sphinx/builders/latex/transforms.py @@ -561,7 +561,7 @@ class MathReferenceTransform(SphinxTransform): equations = self.env.get_domain('math').data['objects'] for node in self.document.traverse(addnodes.pending_xref): - if node['refdomain'] == 'math' and node['reftype'] == 'eq': + if node['refdomain'] == 'math' and node['reftype'] in ('eq', 'numref'): docname, _ = equations.get(node['reftarget'], (None, None)) if docname: refnode = math_reference('', docname=docname, target=node['reftarget']) diff --git a/sphinx/domains/math.py b/sphinx/domains/math.py index 78de09032..c88481746 100644 --- a/sphinx/domains/math.py +++ b/sphinx/domains/math.py @@ -21,10 +21,11 @@ from sphinx.util.nodes import make_refnode if False: # For type annotation - from typing import Any, Callable, Dict, Iterable, List, Tuple # NOQA + from typing import Any, Callable, Dict, Iterable, List, Tuple, Union # NOQA from sphinx.application import Sphinx # NOQA from sphinx.builders import Builder # NOQA from sphinx.environment import BuildEnvironment # NOQA + from sphinx.util.typing import RoleFunction # NOQA logger = logging.getLogger(__name__) @@ -51,6 +52,9 @@ class MathDomain(Domain): displaymath: ('displaymath', None), nodes.math_block: ('displaymath', None), } # type: Dict[nodes.Node, Tuple[unicode, Callable]] + roles = { + 'numref': MathReferenceRole(), + } def clear_doc(self, docname): # type: (unicode) -> None @@ -66,7 +70,7 @@ class MathDomain(Domain): def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): # type: (BuildEnvironment, unicode, Builder, unicode, unicode, nodes.Node, nodes.Node) -> nodes.Node # NOQA - assert typ == 'eq' + assert typ in ('eq', 'numref') docname, number = self.data['objects'].get(target, (None, None)) if docname: # TODO: perhaps use rather a sphinx-core provided prefix here? diff --git a/tests/roots/test-ext-math/math.rst b/tests/roots/test-ext-math/math.rst index 5a209bed4..c05c3a053 100644 --- a/tests/roots/test-ext-math/math.rst +++ b/tests/roots/test-ext-math/math.rst @@ -28,4 +28,4 @@ This is inline math: :math:`a^2 + b^2 = c^2`. a + 1 < b -Referencing equation :eq:`foo`. +Referencing equation :eq:`foo` and :math:numref:`foo`. diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index 99940977b..d949c39a6 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -162,6 +162,7 @@ def test_math_eqref_format_html(app, status, warning): content = (app.outdir / 'math.html').text() html = ('

Referencing equation Eq.1 and Eq.1.

') assert html in content @@ -173,7 +174,8 @@ def test_math_eqref_format_latex(app, status, warning): app.builder.build_all() content = (app.outdir / 'test.tex').text() - macro = r'Referencing equation Eq.\\ref{equation:math:foo}.' + macro = (r'Referencing equation Eq.\\ref{equation:math:foo} and ' + r'Eq.\\ref{equation:math:foo}.') assert re.search(macro, content, re.S) @@ -189,7 +191,8 @@ def test_mathjax_numfig_html(app, status, warning): '(1.2)') assert html in content html = ('

Referencing equation (1.1).

') + 'href="#equation-foo">(1.1) and ' + '(1.1).

') assert html in content @@ -205,7 +208,8 @@ def test_jsmath_numfig_html(app, status, warning): html = '(1.2)Referencing equation (1.1).

') + 'href="#equation-foo">(1.1) and ' + '(1.1).

') assert html in content From 5a220d648ab7008ae845bc86026159f800089c29 Mon Sep 17 00:00:00 2001 From: jfbu Date: Thu, 2 Aug 2018 10:06:31 +0200 Subject: [PATCH 086/174] Fix LaTeX docs of Latin Modern font with XeLaTeX/LuaLaTeX refs: #5251 --- CHANGES | 2 ++ doc/config.rst | 36 +++++++++++++++++++++++++++--------- 2 files changed, 29 insertions(+), 9 deletions(-) diff --git a/CHANGES b/CHANGES index d24322385..26d016677 100644 --- a/CHANGES +++ b/CHANGES @@ -24,6 +24,8 @@ Bugs fixed console output with recent LaTeX (refs: #5237) * #5234: PDF output: usage of PAPER environment variable is broken since Sphinx 1.5 +* LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern + font with XeLaTeX/LuaLateX (refs: #5251) Testing -------- diff --git a/doc/config.rst b/doc/config.rst index d5c32ca4a..97c1a3df0 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -1632,15 +1632,33 @@ These options influence LaTeX output. See further :doc:`latex`. preamble. If your project uses such extra Unicode characters, switching the engine to - XeLaTeX or LuaLaTeX often provides a quick fix. They only work with UTF-8 - encoded sources and can (in fact, should) use OpenType fonts, either from - the system or the TeX install tree. Recent LaTeX releases will default with - these engines to the Latin Modern OpenType font, which has good coverage of - Latin and Cyrillic scripts (it is provided by standard LaTeX installation), - and Sphinx does not modify this default. Refer to the documentation of the - LaTeX ``polyglossia`` package to see how to instruct LaTeX to use some - other OpenType font if Unicode coverage proves insufficient (or use - directly ``\setmainfont`` et. al. as in :ref:`this example `.) + XeLaTeX or LuaLaTeX and setting up the document to use an OpenType font + with wide-enough glyph coverage is often easier than sticking with PDFLaTeX + and trying to get it to work with the Unicode characters. + + The :confval:`latex_elements` ``'fontpkg'`` key allows to set up the + document fonts, see :ref:`this example `. Currently, for + XeLaTeX and LuaLaTeX, Sphinx leaves this key empty and LaTeX then defaults + to the `Latin Modern`_ font family (from the TeX distribution fonts). This + font family provides good coverage of Latin scripts (European languages, + Vietnamese) but Cyrillic requires some other OpenType font; for example + Computer Modern Unicode (see `babel-russian`_ documentation on how to load + it in the LaTeX document). In future, it is planned Sphinx will provide + another default choice of OpenType font than `Latin Modern`_, perhaps + `Libertinus`_, which is included in recent TeX distributions and supports + Latin and Cyrillic and also has an accompanying math font. + + With XeLaTeX and LuaLaTeX, Sphinx configures the LaTeX document to use + `polyglossia`_. For some languages the `babel`_ support appears + preferable; Sphinx uses currently `babel`_ for French and perhaps will also + for some more languages in future. One can use the + :confval:`latex_elements` ``'babel'`` key to override Sphinx's default. + + .. _`Latin Modern`: http://www.gust.org.pl/projects/e-foundry/latin-modern + .. _`polyglossia`: https://ctan.org/pkg/polyglossia + .. _`babel`: https://ctan.org/pkg/babel + .. _`babel-russian`: https://ctan.org/pkg/babel-russian + .. _`Libertinus`: https://ctan.org/pkg/libertinus .. confval:: latex_documents From 8a23ad1f44894afefe722fbf43b3ce05d3fa1de0 Mon Sep 17 00:00:00 2001 From: jfbu Date: Thu, 2 Aug 2018 12:46:33 +0200 Subject: [PATCH 087/174] Update LaTeX docs for a 1.7.6 change (refs #5178) --- doc/config.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/config.rst b/doc/config.rst index 97c1a3df0..ddce9a99b 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -1820,6 +1820,9 @@ These options influence LaTeX output. See further :doc:`latex`. is ``'\\usepackage{polyglossia}\n\\setmainlanguage{}'``. .. versionchanged:: 1.6 ``'lualatex'`` uses same default setting as ``'xelatex'`` + .. versionchanged:: 1.7.6 + For French, ``xelatex`` and ``lualatex`` default to using + ``babel``, not ``polyglossia``. ``'fontpkg'`` Font package inclusion, default ``'\\usepackage{times}'`` (which uses Times for text, Helvetica for sans serif and Courier for code-blocks). From a90dea896a72c16cda7b3b9e9baaa9b487483b42 Mon Sep 17 00:00:00 2001 From: "C.A.M. Gerlach" Date: Fri, 3 Aug 2018 03:15:51 -0500 Subject: [PATCH 088/174] Add Spyder to documentation examples list --- EXAMPLES | 1 + 1 file changed, 1 insertion(+) diff --git a/EXAMPLES b/EXAMPLES index 94aade9bc..c47c5cba8 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -36,6 +36,7 @@ Documentation using the alabaster theme * PyVisfile: https://documen.tician.de/pyvisfile/ * Requests: http://www.python-requests.org/ * searx: https://asciimoo.github.io/searx/ +* Spyder: https://docs.spyder-ide.org/ (customized) * Tablib: http://docs.python-tablib.org/ * urllib3: https://urllib3.readthedocs.io/ (customized) * Werkzeug: http://werkzeug.pocoo.org/docs/ (customized) From ae7426fa228519ef88d4979951f5848472a2aaac Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Fri, 3 Aug 2018 23:43:32 +0200 Subject: [PATCH 089/174] List projects integrating Sphinx features --- EXAMPLES | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/EXAMPLES b/EXAMPLES index c47c5cba8..e09503def 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -398,3 +398,14 @@ Theses produced using Sphinx * "Content Conditioning and Distribution for Dynamic Virtual Worlds": https://www.cs.princeton.edu/research/techreps/TR-941-12 * "The Sphinx Thesis Resource": https://jterrace.github.io/sphinxtr/ + +Projects integrating Sphinx functionality +----------------------------------------- + +* *Read the Docs*, a software-as-a-service documentation hosting platform, uses + Sphinx to automatically build documentation updates that are pushed to GitHub: + https://readthedocs.org/ + +* *Spyder: The Scientific Python Development Environment* uses Sphinx in its + help pane to render rich documentation for functions, classes and methods + automatically or on-demand: https://docs.spyder-ide.org/ From 03c72a32676f59ec56ca936a965b6e2f45d700a6 Mon Sep 17 00:00:00 2001 From: "C.A.M. Gerlach" Date: Fri, 3 Aug 2018 16:50:33 -0500 Subject: [PATCH 090/174] Fix Spyder help link and slight tweak to proper full name --- EXAMPLES | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EXAMPLES b/EXAMPLES index e09503def..e988a9965 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -406,6 +406,6 @@ Projects integrating Sphinx functionality Sphinx to automatically build documentation updates that are pushed to GitHub: https://readthedocs.org/ -* *Spyder: The Scientific Python Development Environment* uses Sphinx in its +* *Spyder*, the Scientific Python Development Environment, uses Sphinx in its help pane to render rich documentation for functions, classes and methods - automatically or on-demand: https://docs.spyder-ide.org/ + automatically or on-demand: https://docs.spyder-ide.org/help.html From 701a8ef76071887fb635a7cb56a3d8227851f2c9 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 4 Aug 2018 20:47:30 +0900 Subject: [PATCH 091/174] test: Run tests for python-nightly-builds on xenial --- .travis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.travis.yml b/.travis.yml index 404daa8e5..f156d59d7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,6 +31,8 @@ matrix: sudo: true - python: 'nightly' env: TOXENV=py38 + dist: xenial + sudo: true - python: '3.6' env: TOXENV=docs - python: '3.6' From f47f2353d38a23c152c8d4f8cafaa59c2af58a03 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 31 Jan 2018 20:43:54 +0900 Subject: [PATCH 092/174] quickstart: epub builder is enabled by default --- CHANGES | 2 ++ sphinx/cmd/quickstart.py | 8 -------- sphinx/templates/quickstart/conf.py_t | 2 -- 3 files changed, 2 insertions(+), 10 deletions(-) diff --git a/CHANGES b/CHANGES index b83f1925f..2b0389ae1 100644 --- a/CHANGES +++ b/CHANGES @@ -55,6 +55,7 @@ Deprecated ---------- * :confval:`source_parsers` is deprecated +* quickstart: ``--epub`` option becomes default, so it is deprecated * Drop function based directive support. For now, Sphinx only supports class based directives. * ``sphinx.util.docutils.directive_helper()`` is deprecated @@ -186,6 +187,7 @@ Features added * #5140: linkcheck: Add better Accept header to HTTP client * #4614: sphinx-build: Add ``--keep-going`` option to show all warnings * Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`) +* quickstart: epub builder is enabled by default Bugs fixed ---------- diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index 14217d1a7..6b003c926 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -74,7 +74,6 @@ DEFAULTS = { 'language': None, 'suffix': '.rst', 'master': 'index', - 'epub': False, 'makefile': True, 'batchfile': True, } @@ -246,7 +245,6 @@ def ask_user(d): * language: document language * suffix: source file suffix * master: master document name - * epub: use epub (bool) * extensions: extensions to use (list) * makefile: make Makefile * batchfile: make command file @@ -347,12 +345,6 @@ document is a custom template, you can also set this to another filename.''')) d['master'] = do_prompt(__('Please enter a new file name, or rename the ' 'existing file and press Enter'), d['master']) - if 'epub' not in d: - print(__(''' -Sphinx can also add configuration for epub output:''')) - d['epub'] = do_prompt(__('Do you want to use the epub builder (y/n)'), - 'n', boolean) - if 'extensions' not in d: print(__('Indicate which of the following Sphinx extensions should be ' 'enabled:')) diff --git a/sphinx/templates/quickstart/conf.py_t b/sphinx/templates/quickstart/conf.py_t index cc8073a82..37eef3589 100644 --- a/sphinx/templates/quickstart/conf.py_t +++ b/sphinx/templates/quickstart/conf.py_t @@ -165,7 +165,6 @@ texinfo_documents = [ author, '{{ project_fn }}', 'One line description of project.', 'Miscellaneous'), ] -{%- if epub %} # -- Options for Epub output ------------------------------------------------- @@ -187,7 +186,6 @@ epub_copyright = copyright # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] -{%- endif %} {%- if extensions %} From dc4f8d4836fdfc41fc39a1dd7c662eeb401d4945 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 31 Jan 2018 20:43:55 +0900 Subject: [PATCH 093/174] conf.py: Drop epub_author, epub_publisher and epub_copyright The default values of them are same as conf.py's. So it is not needed to override the setting. --- sphinx/templates/quickstart/conf.py_t | 3 --- tests/test_quickstart.py | 1 - 2 files changed, 4 deletions(-) diff --git a/sphinx/templates/quickstart/conf.py_t b/sphinx/templates/quickstart/conf.py_t index 37eef3589..79c78ae93 100644 --- a/sphinx/templates/quickstart/conf.py_t +++ b/sphinx/templates/quickstart/conf.py_t @@ -171,9 +171,6 @@ texinfo_documents = [ # Bibliographic Dublin Core info. epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright # The unique identifier of the text. This can be a ISBN number # or the project homepage. diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index fccd3d66b..64c38457d 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -197,7 +197,6 @@ def test_quickstart_all_answers(tempdir): assert ns['latex_documents'] == [ ('contents', 'STASI.tex', u'STASI™ Documentation', u'Wolfgang Schäuble \\& G\'Beckstein', 'manual')] - assert ns['epub_author'] == u'Wolfgang Schäuble & G\'Beckstein' assert ns['man_pages'] == [ ('contents', 'stasi', u'STASI™ Documentation', [u'Wolfgang Schäuble & G\'Beckstein'], 1)] From f591cba27fdd27572d89fa8729e6ea1abbbfd4f9 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 4 Aug 2018 18:38:39 +0900 Subject: [PATCH 094/174] Fix #5002: graphviz: SVGs do not adapt to the column width --- CHANGES | 1 + sphinx/ext/graphviz.py | 29 +++++++++++++++++++------- sphinx/templates/graphviz/graphviz.css | 19 +++++++++++++++++ tests/test_ext_graphviz.py | 6 +++--- tests/test_ext_inheritance_diagram.py | 10 ++++----- 5 files changed, 50 insertions(+), 15 deletions(-) create mode 100644 sphinx/templates/graphviz/graphviz.css diff --git a/CHANGES b/CHANGES index b83f1925f..3f2fbbf7e 100644 --- a/CHANGES +++ b/CHANGES @@ -200,6 +200,7 @@ Bugs fixed * #5114: sphinx-build: Handle errors on scanning documents * epub: spine has been broken when "self" is listed on toctree (refs: #4611) * #344: autosummary does not understand docstring of module level attributes +* #5002: graphviz: SVGs do not adapt to the column width Testing -------- diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 11d9e54a0..3b33c7b79 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -27,6 +27,7 @@ from sphinx.errors import SphinxError from sphinx.locale import _, __ from sphinx.util import logging from sphinx.util.docutils import SphinxDirective +from sphinx.util.fileutil import copy_asset_file from sphinx.util.i18n import search_image_for_language from sphinx.util.osutil import ensuredir, ENOENT, EPIPE, EINVAL @@ -281,19 +282,23 @@ def render_dot_html(self, node, code, options, prefix='graphviz', logger.warning(__('dot code %r: %s'), code, text_type(exc)) raise nodes.SkipNode + if imgcls: + imgcls += " graphviz" + else: + imgcls = "graphviz" + if fname is None: self.body.append(self.encode(code)) else: if alt is None: alt = node.get('alt', self.encode(code).strip()) - imgcss = imgcls and 'class="%s"' % imgcls or '' if 'align' in node: self.body.append('
' % (node['align'], node['align'])) if format == 'svg': self.body.append('
') - self.body.append('\n' % - (fname, imgcss)) + self.body.append('\n' % + (fname, imgcls)) self.body.append('

%s

' % alt) self.body.append('\n') else: @@ -302,15 +307,15 @@ def render_dot_html(self, node, code, options, prefix='graphviz', if imgmap.clickable: # has a map self.body.append('
') - self.body.append('%s' % - (fname, alt, imgmap.id, imgcss)) + self.body.append('%s' % + (fname, alt, imgmap.id, imgcls)) self.body.append('
\n') self.body.append(imgmap.generate_clickable_map()) else: # nothing in image map self.body.append('
') - self.body.append('%s' % - (fname, alt, imgcss)) + self.body.append('%s' % + (fname, alt, imgcls)) self.body.append('
\n') if 'align' in node: self.body.append('\n') @@ -396,6 +401,14 @@ def man_visit_graphviz(self, node): raise nodes.SkipNode +def on_build_finished(app, exc): + # type: (Sphinx, Exception) -> None + if exc is None: + src = path.join(sphinx.package_dir, 'templates', 'graphviz', 'graphviz.css') + dst = path.join(app.outdir, '_static') + copy_asset_file(src, dst) + + def setup(app): # type: (Sphinx) -> Dict[unicode, Any] app.add_node(graphviz, @@ -410,4 +423,6 @@ def setup(app): app.add_config_value('graphviz_dot', 'dot', 'html') app.add_config_value('graphviz_dot_args', [], 'html') app.add_config_value('graphviz_output_format', 'png', 'html') + app.add_css_file('graphviz.css') + app.connect('build-finished', on_build_finished) return {'version': sphinx.__display_version__, 'parallel_read_safe': True} diff --git a/sphinx/templates/graphviz/graphviz.css b/sphinx/templates/graphviz/graphviz.css new file mode 100644 index 000000000..1f246c8d9 --- /dev/null +++ b/sphinx/templates/graphviz/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/tests/test_ext_graphviz.py b/tests/test_ext_graphviz.py index 9b53876db..d0358b407 100644 --- a/tests/test_ext_graphviz.py +++ b/tests/test_ext_graphviz.py @@ -30,7 +30,7 @@ def test_graphviz_png_html(app, status, warning): html = 'Hello
\n graphviz world' assert re.search(html, content, re.S) - html = 'digraph {\n bar -> baz\n}' + html = 'digraph {\n bar -> baz\n}' assert re.search(html, content, re.M) html = (r'
\s*' @@ -41,7 +41,7 @@ def test_graphviz_png_html(app, status, warning): html = (r'
' r'
\"digraph
\n
') + r'}\" class="graphviz" />
\n') assert re.search(html, content, re.S) @@ -117,7 +117,7 @@ def test_graphviz_i18n(app, status, warning): app.builder.build_all() content = (app.outdir / 'index.html').text() - html = 'digraph {\n BAR -> BAZ\n}' + html = 'digraph {\n BAR -> BAZ\n}' assert re.search(html, content, re.M) diff --git a/tests/test_ext_inheritance_diagram.py b/tests/test_ext_inheritance_diagram.py index 8456cda4a..711e0712c 100644 --- a/tests/test_ext_inheritance_diagram.py +++ b/tests/test_ext_inheritance_diagram.py @@ -27,8 +27,8 @@ def test_inheritance_diagram_png_html(app, status, warning): pattern = ('
\n' '
' 'Inheritance diagram of test.Foo
\n

' - 'Test Foo!

\n

' + 'Test Foo!\xb6

') assert re.search(pattern, content, re.M) @@ -44,7 +44,7 @@ def test_inheritance_diagram_svg_html(app, status, warning): pattern = ('
\n' '
' '\n' + 'type="image/svg\\+xml" class="inheritance graphviz">\n' '

Inheritance diagram of test.Foo

' '
\n

' 'Test Foo!\n' '

' 'Inheritance diagram of test.Foo
\n

' - 'Test Foo!

\n

' + 'Test Foo!\xb6

') assert re.search(pattern, content, re.M) From 7e4e129da2f4928678f8339901b10973e1494c8f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 4 Aug 2018 21:17:07 +0900 Subject: [PATCH 095/174] latex: Create an empty .ind file by perl (for Windows) --- sphinx/texinputs/latexmkrc_t | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/sphinx/texinputs/latexmkrc_t b/sphinx/texinputs/latexmkrc_t index fba2f292e..a33b54148 100644 --- a/sphinx/texinputs/latexmkrc_t +++ b/sphinx/texinputs/latexmkrc_t @@ -11,7 +11,18 @@ $pdflatex = 'xelatex ' . $ENV{'LATEXOPTS'} . ' %O %S'; $lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S'; $xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S'; {% if xindy_use -%} -$makeindex = '[ ! -s %S ] && : > %D || xindy ' . $ENV{'XINDYOPTS'} . ' %O -o %D %S'; +$makeindex = 'internal xindy ' . $ENV{'XINDYOPTS'} . ' %O -o %D %S'; +sub xindy { + my @args = @_; + if (-z $args[-1]) { + # create an empty .ind file if .idx is empty + open(FH, ">" . $args[-2]); + close(FH); + return 0; + } else { + return system("xindy", @args); + } +} {% else -%} $makeindex = 'makeindex -s python.ist %O -o %D %S'; {% endif -%} From de73ee5902be1c1741f7ff46763c3db1ba3059c4 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 31 Jul 2018 20:14:18 +0900 Subject: [PATCH 096/174] refactor: test_autodoc --- tests/test_autodoc.py | 375 ++++++++++++++++++++++++++---------------- 1 file changed, 236 insertions(+), 139 deletions(-) diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 168002c52..ac7abaa83 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -19,7 +19,7 @@ from docutils.statemachine import ViewList from six import PY3 from sphinx.ext.autodoc import ( - AutoDirective, ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL + AutoDirective, ModuleLevelDocumenter, cut_lines, between, ALL ) from sphinx.ext.autodoc.directive import DocumenterBridge, process_documenter_options from sphinx.testing.util import SphinxTestApp, Struct # NOQA @@ -28,6 +28,11 @@ from sphinx.util.docutils import LoggingReporter app = None +if PY3: + ROGER_METHOD = ' .. py:classmethod:: Class.roger(a, *, b=2, c=3, d=4, e=5, f=6)' +else: + ROGER_METHOD = ' .. py:classmethod:: Class.roger(a, e=5, f=6)' + def do_autodoc(app, objtype, name, options={}): doccls = app.registry.documenters[objtype] @@ -617,73 +622,12 @@ def test_attrgetter_using(): @pytest.mark.usefixtures('setup_test') def test_generate(): - logging.setup(app, app._status, app._warning) - - def assert_warns(warn_str, objtype, name, **kw): - inst = app.registry.documenters[objtype](directive, name) - inst.generate(**kw) - assert len(directive.result) == 0, directive.result - - assert warn_str in app._warning.getvalue() - app._warning.truncate(0) - - def assert_works(objtype, name, **kw): - inst = app.registry.documenters[objtype](directive, name) - inst.generate(**kw) - assert directive.result - # print '\n'.join(directive.result) - assert app._warning.getvalue() == '' - del directive.result[:] - - def assert_processes(items, objtype, name, **kw): - del processed_docstrings[:] - del processed_signatures[:] - assert_works(objtype, name, **kw) - assert set(processed_docstrings) | set(processed_signatures) == set(items) - def assert_result_contains(item, objtype, name, **kw): inst = app.registry.documenters[objtype](directive, name) inst.generate(**kw) - # print '\n'.join(directive.result) - assert app._warning.getvalue() == '' assert item in directive.result del directive.result[:] - def assert_order(items, objtype, name, member_order, **kw): - inst = app.registry.documenters[objtype](directive, name) - inst.options.member_order = member_order - inst.generate(**kw) - assert app._warning.getvalue() == '' - items = list(reversed(items)) - lineiter = iter(directive.result) - # for line in directive.result: - # if line.strip(): - # print repr(line) - while items: - item = items.pop() - for line in lineiter: - if line == item: - break - else: # ran out of items! - assert False, ('item %r not found in result or not in the ' - ' correct order' % item) - del directive.result[:] - - options.members = [] - - # no module found? - assert_warns("import for autodocumenting 'foobar'", - 'function', 'foobar', more_content=None) - # importing - assert_warns("failed to import module 'test_foobar'", - 'module', 'test_foobar', more_content=None) - # attributes missing - assert_warns("failed to import function 'foobar' from module 'util'", - 'function', 'util.foobar', more_content=None) - # method missing - assert_warns("failed to import method 'Class.foobar' from module 'target';", - 'method', 'target.Class.foobar', more_content=None) - # test auto and given content mixing directive.env.ref_context['py:module'] = 'target' assert_result_contains(' Function.', 'method', 'Class.meth') @@ -694,80 +638,238 @@ def test_generate(): assert_result_contains(' Content.', 'method', 'Class.meth', more_content=add_content) - # test check_module - inst = FunctionDocumenter(directive, 'add_documenter') - inst.generate(check_module=True) - assert len(directive.result) == 0 - # assert that exceptions can be documented - assert_works('exception', 'target.CustomEx', all_members=True) - assert_works('exception', 'target.CustomEx') +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_exception(app): + actual = do_autodoc(app, 'exception', 'target.CustomEx') + assert list(actual) == [ + '', + '.. py:exception:: CustomEx', + ' :module: target', + '', + ' My custom exception.', + ' ' + ] - # test diverse inclusion settings for members - should = [('class', 'target.Class')] - assert_processes(should, 'class', 'Class') - should.extend([('method', 'target.Class.meth')]) - options.members = ['meth'] - options.exclude_members = set(['excludemeth']) - assert_processes(should, 'class', 'Class') - should.extend([('attribute', 'target.Class.prop'), - ('attribute', 'target.Class.descr'), - ('attribute', 'target.Class.attr'), - ('attribute', 'target.Class.docattr'), - ('attribute', 'target.Class.udocattr'), - ('attribute', 'target.Class.mdocattr'), - ('attribute', 'target.Class.inst_attr_comment'), - ('attribute', 'target.Class.inst_attr_inline'), - ('attribute', 'target.Class.inst_attr_string'), - ('method', 'target.Class.moore'), - ]) - options.members = ALL - assert_processes(should, 'class', 'Class') - options.undoc_members = True - should.extend((('attribute', 'target.Class.skipattr'), - ('method', 'target.Class.undocmeth'), - ('method', 'target.Class.roger'))) - assert_processes(should, 'class', 'Class') - options.inherited_members = True - should.append(('method', 'target.Class.inheritedmeth')) - should.append(('method', 'target.Class.inheritedclassmeth')) - should.append(('method', 'target.Class.inheritedstaticmeth')) - assert_processes(should, 'class', 'Class') - # test special members - options.special_members = ['__special1__'] - should.append(('method', 'target.Class.__special1__')) - assert_processes(should, 'class', 'Class') - options.special_members = ALL - should.append(('method', 'target.Class.__special2__')) - assert_processes(should, 'class', 'Class') - options.special_members = False +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_warnings(app, warning): + app.env.temp_data['docname'] = 'dummy' - options.members = [] - # test module flags - assert_result_contains('.. py:module:: target', - 'module', 'target') - options.synopsis = 'Synopsis' - assert_result_contains(' :synopsis: Synopsis', 'module', 'target') - options.deprecated = True - assert_result_contains(' :deprecated:', 'module', 'target') - options.platform = 'Platform' - assert_result_contains(' :platform: Platform', 'module', 'target') - # test if __all__ is respected for modules - options.members = ALL - assert_result_contains('.. py:class:: Class(arg)', 'module', 'target') - try: - assert_result_contains('.. py:exception:: CustomEx', - 'module', 'target') - except AssertionError: - pass - else: - assert False, 'documented CustomEx which is not in __all__' + # can't import module + do_autodoc(app, 'module', 'unknown') + assert "failed to import module 'unknown'" in warning.getvalue() - # test ignore-module-all - options.ignore_module_all = True - assert_result_contains('.. py:class:: Class(arg)', 'module', 'target') - assert_result_contains('.. py:exception:: CustomEx', 'module', 'target') + # missing function + do_autodoc(app, 'function', 'unknown') + assert "import for autodocumenting 'unknown'" in warning.getvalue() + + do_autodoc(app, 'function', 'target.unknown') + assert "failed to import function 'unknown' from module 'target'" in warning.getvalue() + + # missing method + do_autodoc(app, 'method', 'target.Class.unknown') + assert "failed to import method 'Class.unknown' from module 'target'" in warning.getvalue() + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_attributes(app): + options = {"synopsis": 'Synopsis', + "platform": "Platform", + "deprecated": None} + actual = do_autodoc(app, 'module', 'target', options) + assert list(actual) == [ + '', + '.. py:module:: target', + ' :synopsis: Synopsis', + ' :platform: Platform', + ' :deprecated:', + '' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_members(app): + # default (no-members) + actual = do_autodoc(app, 'class', 'target.Base') + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Base', + ] + + # default ALL-members + options = {"members": None} + actual = do_autodoc(app, 'class', 'target.Base', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Base', + ' .. py:classmethod:: Base.inheritedclassmeth()', + ' .. py:method:: Base.inheritedmeth()', + ' .. py:staticmethod:: Base.inheritedstaticmeth(cls)' + ] + + # default specific-members + options = {"members": "inheritedmeth,inheritedstaticmeth"} + actual = do_autodoc(app, 'class', 'target.Base', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Base', + ' .. py:method:: Base.inheritedmeth()', + ' .. py:staticmethod:: Base.inheritedstaticmeth(cls)' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_exclude_members(app): + options = {"members": None, + "exclude-members": "inheritedmeth,inheritedstaticmeth"} + actual = do_autodoc(app, 'class', 'target.Base', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Base', + ' .. py:classmethod:: Base.inheritedclassmeth()' + ] + + # members vs exclude-members + options = {"members": "inheritedmeth", + "exclude-members": "inheritedmeth"} + actual = do_autodoc(app, 'class', 'target.Base', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Base', + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_undoc_members(app): + options = {"members": None, + "undoc-members": None} + actual = do_autodoc(app, 'class', 'target.Class', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Class(arg)', + ' .. py:attribute:: Class.attr', + ' .. py:attribute:: Class.descr', + ' .. py:attribute:: Class.docattr', + ' .. py:method:: Class.excludemeth()', + ' .. py:attribute:: Class.inst_attr_comment', + ' .. py:attribute:: Class.inst_attr_inline', + ' .. py:attribute:: Class.inst_attr_string', + ' .. py:attribute:: Class.mdocattr', + ' .. py:method:: Class.meth()', + ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', + ' .. py:attribute:: Class.prop', + ROGER_METHOD, + ' .. py:attribute:: Class.skipattr', + ' .. py:method:: Class.skipmeth()', + ' .. py:attribute:: Class.udocattr', + ' .. py:method:: Class.undocmeth()' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_inherited_members(app): + options = {"members": None, + "inherited-members": None} + actual = do_autodoc(app, 'class', 'target.Class', options) + assert list(filter(lambda l: 'method::' in l, actual)) == [ + ' .. py:method:: Class.excludemeth()', + ' .. py:classmethod:: Class.inheritedclassmeth()', + ' .. py:method:: Class.inheritedmeth()', + ' .. py:staticmethod:: Class.inheritedstaticmeth(cls)', + ' .. py:method:: Class.meth()', + ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', + ' .. py:method:: Class.skipmeth()' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_imported_members(app): + options = {"members": None, + "imported-members": None, + "ignore-module-all": None} + actual = do_autodoc(app, 'module', 'target', options) + assert '.. py:function:: add_documenter(cls)' in actual + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_special_members(app): + # all special methods + options = {"members": None, + "undoc-members": None, + "special-members": None} + actual = do_autodoc(app, 'class', 'target.Class', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Class(arg)', + ' .. py:method:: Class.__init__(arg)', + ' .. py:attribute:: Class.__module__', + ' .. py:method:: Class.__special1__()', + ' .. py:method:: Class.__special2__()', + ' .. py:attribute:: Class.attr', + ' .. py:attribute:: Class.descr', + ' .. py:attribute:: Class.docattr', + ' .. py:method:: Class.excludemeth()', + ' .. py:attribute:: Class.inst_attr_comment', + ' .. py:attribute:: Class.inst_attr_inline', + ' .. py:attribute:: Class.inst_attr_string', + ' .. py:attribute:: Class.mdocattr', + ' .. py:method:: Class.meth()', + ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', + ' .. py:attribute:: Class.prop', + ROGER_METHOD, + ' .. py:attribute:: Class.skipattr', + ' .. py:method:: Class.skipmeth()', + ' .. py:attribute:: Class.udocattr', + ' .. py:method:: Class.undocmeth()' + ] + + # specific special methods + options = {"members": None, + "undoc-members": None, + "special-members": "__init__,__special1__"} + actual = do_autodoc(app, 'class', 'target.Class', options) + assert list(filter(lambda l: '::' in l, actual)) == [ + '.. py:class:: Class(arg)', + ' .. py:method:: Class.__init__(arg)', + ' .. py:method:: Class.__special1__()', + ' .. py:attribute:: Class.attr', + ' .. py:attribute:: Class.descr', + ' .. py:attribute:: Class.docattr', + ' .. py:method:: Class.excludemeth()', + ' .. py:attribute:: Class.inst_attr_comment', + ' .. py:attribute:: Class.inst_attr_inline', + ' .. py:attribute:: Class.inst_attr_string', + ' .. py:attribute:: Class.mdocattr', + ' .. py:method:: Class.meth()', + ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', + ' .. py:attribute:: Class.prop', + ROGER_METHOD, + ' .. py:attribute:: Class.skipattr', + ' .. py:method:: Class.skipmeth()', + ' .. py:attribute:: Class.udocattr', + ' .. py:method:: Class.undocmeth()' + ] + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_ignore_module_all(app): + # default (no-ignore-module-all) + options = {"members": None} + actual = do_autodoc(app, 'module', 'target', options) + assert list(filter(lambda l: 'class::' in l, actual)) == [ + '.. py:class:: Class(arg)', + ] + + # ignore-module-all + options = {"members": None, + "ignore-module-all": None} + actual = do_autodoc(app, 'module', 'target', options) + assert list(filter(lambda l: 'class::' in l, actual)) == [ + '.. py:class:: Class(arg)', + '.. py:class:: CustomDataDescriptor(doc)', + '.. py:class:: CustomDataDescriptor2(doc)', + '.. py:class:: CustomDataDescriptorMeta', + '.. py:class:: CustomDict', + '.. py:class:: EnumCls', + '.. py:class:: InstAttCls()', + '.. py:class:: Outer', + ' .. py:class:: Outer.Inner', + '.. py:class:: StrRepr' + ] @pytest.mark.sphinx('html', testroot='ext-autodoc') @@ -889,11 +991,6 @@ def test_autodoc_c_module(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autodoc_member_order(app): - if PY3: - roger_method = ' .. py:classmethod:: Class.roger(a, *, b=2, c=3, d=4, e=5, f=6)' - else: - roger_method = ' .. py:classmethod:: Class.roger(a, e=5, f=6)' - # case member-order='bysource' options = {"members": None, 'member-order': 'bysource', @@ -913,7 +1010,7 @@ def test_autodoc_member_order(app): ' .. py:attribute:: Class.docattr', ' .. py:attribute:: Class.udocattr', ' .. py:attribute:: Class.mdocattr', - roger_method, + ROGER_METHOD, ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', ' .. py:attribute:: Class.inst_attr_inline', ' .. py:attribute:: Class.inst_attr_comment', @@ -932,7 +1029,7 @@ def test_autodoc_member_order(app): ' .. py:method:: Class.excludemeth()', ' .. py:method:: Class.meth()', ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', - roger_method, + ROGER_METHOD, ' .. py:method:: Class.skipmeth()', ' .. py:method:: Class.undocmeth()', ' .. py:attribute:: Class._private_inst_attr', @@ -967,7 +1064,7 @@ def test_autodoc_member_order(app): ' .. py:method:: Class.meth()', ' .. py:classmethod:: Class.moore(a, e, f) -> happiness', ' .. py:attribute:: Class.prop', - roger_method, + ROGER_METHOD, ' .. py:attribute:: Class.skipattr', ' .. py:method:: Class.skipmeth()', ' .. py:attribute:: Class.udocattr', From 7e546c0e0b6389a9fb0454da2f37e1f17f71db85 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 1 Aug 2018 00:29:27 +0900 Subject: [PATCH 097/174] refactor: Remove duplicated testcase --- tests/test_autodoc.py | 37 ------------------------------------- 1 file changed, 37 deletions(-) diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index ac7abaa83..d3e69766f 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -517,43 +517,6 @@ def test_docstring_processing(): app.disconnect(lid) -@pytest.mark.usefixtures('setup_test') -def test_docstring_property_processing(): - def genarate_docstring(objtype, name, **kw): - del processed_docstrings[:] - del processed_signatures[:] - inst = app.registry.documenters[objtype](directive, name) - inst.generate(**kw) - results = list(directive.result) - docstrings = inst.get_doc()[0] - del directive.result[:] - return results, docstrings - - directive.env.config.autodoc_docstring_signature = False - results, docstrings = \ - genarate_docstring('attribute', 'target.DocstringSig.prop1') - assert '.. py:attribute:: DocstringSig.prop1' in results - assert 'First line of docstring' in docstrings - assert 'DocstringSig.prop1(self)' in docstrings - results, docstrings = \ - genarate_docstring('attribute', 'target.DocstringSig.prop2') - assert '.. py:attribute:: DocstringSig.prop2' in results - assert 'First line of docstring' in docstrings - assert 'Second line of docstring' in docstrings - - directive.env.config.autodoc_docstring_signature = True - results, docstrings = \ - genarate_docstring('attribute', 'target.DocstringSig.prop1') - assert '.. py:attribute:: DocstringSig.prop1' in results - assert 'First line of docstring' in docstrings - assert 'DocstringSig.prop1(self)' not in docstrings - results, docstrings = \ - genarate_docstring('attribute', 'target.DocstringSig.prop2') - assert '.. py:attribute:: DocstringSig.prop2' in results - assert 'First line of docstring' in docstrings - assert 'Second line of docstring' in docstrings - - @pytest.mark.usefixtures('setup_test') def test_new_documenter(): logging.setup(app, app._status, app._warning) From 684f69d9dcd41d05e216d0f5508fbc5f884f3781 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Sun, 5 Aug 2018 14:57:13 +0200 Subject: [PATCH 098/174] C++, fix some wrong type annotations --- sphinx/domains/cpp.py | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index aebc5d245..678cdfc3a 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -2085,7 +2085,7 @@ class ASTTrailingTypeSpecName(ASTBase): @property def name(self): - # type: () -> Any + # type: () -> ASTNestedName return self.nestedName def get_id(self, version): @@ -2379,7 +2379,7 @@ class ASTDeclSpecs(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.trailingTypeSpec.name def get_id(self, version): @@ -2487,7 +2487,7 @@ class ASTDeclaratorPtr(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.next.name @property @@ -2583,7 +2583,7 @@ class ASTDeclaratorRef(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.next.name @property @@ -2638,7 +2638,7 @@ class ASTDeclaratorParamPack(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.next.name @property @@ -2702,7 +2702,7 @@ class ASTDeclaratorMemPtr(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.next.name @property @@ -2798,7 +2798,7 @@ class ASTDeclaratorParen(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.inner.name @property @@ -2864,7 +2864,7 @@ class ASTDeclaratorNameParamQual(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.declId @property @@ -2962,9 +2962,8 @@ class ASTType(ASTBase): @property def name(self): - # type: () -> unicode - name = self.decl.name - return name + # type: () -> ASTNestedName + return self.decl.name @property def function_params(self): @@ -3054,7 +3053,7 @@ class ASTTypeWithInit(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.type.name def get_id(self, version, objectType=None, symbol=None): @@ -3122,7 +3121,7 @@ class ASTConcept(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.nestedName def get_id(self, version, objectType=None, symbol=None): @@ -3326,7 +3325,7 @@ class ASTDeclaration(ASTBase): @property def name(self): - # type: () -> unicode + # type: () -> ASTNestedName return self.declaration.name @property From 91f736b0879b34d95ce4b80bcc5f11eb59ec4df8 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Sun, 5 Aug 2018 15:08:25 +0200 Subject: [PATCH 099/174] C++, prevent nested declarations in functions. Fixes sphinx-doc/sphinx#5191 --- CHANGES | 1 + sphinx/domains/cpp.py | 33 +++++++++++++++++++++++++++++---- 2 files changed, 30 insertions(+), 4 deletions(-) diff --git a/CHANGES b/CHANGES index b83f1925f..665438a54 100644 --- a/CHANGES +++ b/CHANGES @@ -200,6 +200,7 @@ Bugs fixed * #5114: sphinx-build: Handle errors on scanning documents * epub: spine has been broken when "self" is listed on toctree (refs: #4611) * #344: autosummary does not understand docstring of module level attributes +* #5191: C++, prevent nested declarations in functions to avoid lookup problems. Testing -------- diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 678cdfc3a..7b2d3517e 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -5790,12 +5790,37 @@ class CPPObject(ObjectDescription): # type: (addnodes.desc_signature, Any, Dict) -> None ast.describe_signature(signode, 'lastIsName', self.env, options) + def run(self): + env = self.state.document.settings.env # from ObjectDescription.run + if 'cpp:parent_symbol' not in env.temp_data: + root = env.domaindata['cpp']['root_symbol'] + env.temp_data['cpp:parent_symbol'] = root + env.ref_context['cpp:parent_key'] = root.get_lookup_key() + + # The lookup keys assume that no nested scopes exists inside overloaded functions. + # (see also #5191) + # Example: + # .. cpp:function:: void f(int) + # .. cpp:function:: void f(double) + # + # .. cpp:function:: void g() + # + # :cpp:any:`boom` + # + # So we disallow any signatures inside functions. + parentSymbol = env.temp_data['cpp:parent_symbol'] + parentDecl = parentSymbol.declaration + if parentDecl is not None and parentDecl.objectType == 'function': + self.warn("C++ declarations inside functions are not supported." + + " Parent function is " + text_type(parentSymbol.get_full_nested_name())) + name = _make_phony_error_name() + symbol = parentSymbol.add_name(name) + env.temp_data['cpp:last_symbol'] = symbol + return [] + return ObjectDescription.run(self) + def handle_signature(self, sig, signode): # type: (unicode, addnodes.desc_signature) -> Any - if 'cpp:parent_symbol' not in self.env.temp_data: - root = self.env.domaindata['cpp']['root_symbol'] - self.env.temp_data['cpp:parent_symbol'] = root - self.env.ref_context['cpp:parent_key'] = root.get_lookup_key() parentSymbol = self.env.temp_data['cpp:parent_symbol'] parser = DefinitionParser(sig, self, self.env.config) From 6092f99ffba1a477f5850048ff05f7a56a203bc5 Mon Sep 17 00:00:00 2001 From: Rok Roskar Date: Tue, 10 Jul 2018 01:06:01 +0200 Subject: [PATCH 100/174] graphviz: run dot in the document directory addresses #4033 Co-authored-by: Jiri Kuncar --- sphinx/ext/graphviz.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 11d9e54a0..cb7314596 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -238,7 +238,8 @@ def render_dot(self, code, options, format, prefix='graphviz'): if format == 'png': dot_args.extend(['-Tcmapx', '-o%s.map' % outfn]) try: - p = Popen(dot_args, stdout=PIPE, stdin=PIPE, stderr=PIPE) + p = Popen(dot_args, stdout=PIPE, stdin=PIPE, stderr=PIPE, cwd=path.dirname( + path.join(self.builder.srcdir, self.builder.current_docname))) except OSError as err: if err.errno != ENOENT: # No such file or directory raise From 5125859751d69637ae71b4a582815bb48fef2d2a Mon Sep 17 00:00:00 2001 From: Rok Roskar Date: Mon, 23 Jul 2018 16:51:02 +0200 Subject: [PATCH 101/174] added to incompatible changes --- CHANGES | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGES b/CHANGES index d7761f542..fffb5c846 100644 --- a/CHANGES +++ b/CHANGES @@ -7,6 +7,9 @@ Dependencies Incompatible changes -------------------- +* #5156: the :py:mod:`sphinx.ext.graphviz: extension runs `dot` in the + directory of the document being built instead of in the root directory of + the documentation. * #4460: extensions which stores any data to environment should return the version of its env data structure as metadata. In detail, please see :ref:`ext-metadata`. From a59c572ec649123b112f8265cd9d72c5c4dd36b1 Mon Sep 17 00:00:00 2001 From: Rok Roskar Date: Mon, 23 Jul 2018 16:54:06 +0200 Subject: [PATCH 102/174] graphviz: make path construction more readable --- sphinx/ext/graphviz.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index cb7314596..f72c4df38 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -235,11 +235,14 @@ def render_dot(self, code, options, format, prefix='graphviz'): dot_args = [graphviz_dot] dot_args.extend(self.builder.config.graphviz_dot_args) dot_args.extend(['-T' + format, '-o' + outfn]) + + cwd = path.dirname( + path.join(self.builder.srcdir, self.builder.env.docname)) + if format == 'png': dot_args.extend(['-Tcmapx', '-o%s.map' % outfn]) try: - p = Popen(dot_args, stdout=PIPE, stdin=PIPE, stderr=PIPE, cwd=path.dirname( - path.join(self.builder.srcdir, self.builder.current_docname))) + p = Popen(dot_args, stdout=PIPE, stdin=PIPE, stderr=PIPE, cwd=cwd) except OSError as err: if err.errno != ENOENT: # No such file or directory raise From 16734bb11c2652ef92064aaa3226fb59cc555646 Mon Sep 17 00:00:00 2001 From: Rok Roskar Date: Mon, 30 Jul 2018 22:36:39 +0200 Subject: [PATCH 103/174] graphviz: add document name to graphviz node --- sphinx/ext/graphviz.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index f72c4df38..521a5662e 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -155,7 +155,10 @@ class Graphviz(SphinxDirective): line=self.lineno)] node = graphviz() node['code'] = dotcode - node['options'] = {} + node['options'] = { + 'docpath': path.splitext(self.state.document.current_source)[0], + } + if 'graphviz_dot' in self.options: node['options']['graphviz_dot'] = self.options['graphviz_dot'] if 'alt' in self.options: @@ -192,7 +195,9 @@ class GraphvizSimple(SphinxDirective): node = graphviz() node['code'] = '%s %s {\n%s\n}\n' % \ (self.name, self.arguments[0], '\n'.join(self.content)) - node['options'] = {} + node['options'] = { + 'docpath': path.splitext(self.state.document.current_source)[0], + } if 'graphviz_dot' in self.options: node['options']['graphviz_dot'] = self.options['graphviz_dot'] if 'alt' in self.options: @@ -236,8 +241,7 @@ def render_dot(self, code, options, format, prefix='graphviz'): dot_args.extend(self.builder.config.graphviz_dot_args) dot_args.extend(['-T' + format, '-o' + outfn]) - cwd = path.dirname( - path.join(self.builder.srcdir, self.builder.env.docname)) + cwd = path.dirname(options.get('docpath', self.builder.srcdir)) if format == 'png': dot_args.extend(['-Tcmapx', '-o%s.map' % outfn]) From 615b63563558375117346f628a835fda58a2f11a Mon Sep 17 00:00:00 2001 From: Rok Roskar Date: Mon, 6 Aug 2018 16:27:15 +0200 Subject: [PATCH 104/174] graphviz: rename docpath -> docname --- sphinx/ext/graphviz.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 521a5662e..3c8b3ac50 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -156,7 +156,7 @@ class Graphviz(SphinxDirective): node = graphviz() node['code'] = dotcode node['options'] = { - 'docpath': path.splitext(self.state.document.current_source)[0], + 'docname': path.splitext(self.state.document.current_source)[0], } if 'graphviz_dot' in self.options: @@ -196,7 +196,7 @@ class GraphvizSimple(SphinxDirective): node['code'] = '%s %s {\n%s\n}\n' % \ (self.name, self.arguments[0], '\n'.join(self.content)) node['options'] = { - 'docpath': path.splitext(self.state.document.current_source)[0], + 'docname': path.splitext(self.state.document.current_source)[0], } if 'graphviz_dot' in self.options: node['options']['graphviz_dot'] = self.options['graphviz_dot'] @@ -241,7 +241,8 @@ def render_dot(self, code, options, format, prefix='graphviz'): dot_args.extend(self.builder.config.graphviz_dot_args) dot_args.extend(['-T' + format, '-o' + outfn]) - cwd = path.dirname(options.get('docpath', self.builder.srcdir)) + docname = options.get('docname', 'index') + cwd = path.dirname(path.join(self.builder.srcdir, docname)) if format == 'png': dot_args.extend(['-Tcmapx', '-o%s.map' % outfn]) From 10f01d5539110c2080b69aff90af6ca0d269f0df Mon Sep 17 00:00:00 2001 From: Antti Kaihola Date: Tue, 7 Aug 2018 10:51:49 +0300 Subject: [PATCH 105/174] Fix #5273: doctest: add :skipif: option for doctest directives This option allows conditional skipping of doctests. --- sphinx/ext/doctest.py | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index 68877371c..bd1352b98 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -90,6 +90,16 @@ class TestDirective(SphinxDirective): def run(self): # type: () -> List[nodes.Node] + if 'skipif' in self.options: + condition = self.options['skipif'] + context = {} + if self.config.doctest_global_setup: + exec(self.config.doctest_global_setup, context) + should_skip = eval(condition, context) + if self.config.doctest_global_cleanup: + exec(self.config.doctest_global_cleanup, context) + if should_skip: + return [] # use ordinary docutils nodes for test code: they get special attributes # so that our builder recognizes them, and the other builders are happy. code = '\n'.join(self.content) @@ -155,11 +165,11 @@ class TestDirective(SphinxDirective): class TestsetupDirective(TestDirective): - option_spec = {} # type: Dict + option_spec = {'skipif': directives.unchanged_required} # type: Dict class TestcleanupDirective(TestDirective): - option_spec = {} # type: Dict + option_spec = {'skipif': directives.unchanged_required} # type: Dict class DoctestDirective(TestDirective): @@ -167,6 +177,7 @@ class DoctestDirective(TestDirective): 'hide': directives.flag, 'options': directives.unchanged, 'pyversion': directives.unchanged_required, + 'skipif': directives.unchanged_required, } @@ -174,6 +185,7 @@ class TestcodeDirective(TestDirective): option_spec = { 'hide': directives.flag, 'pyversion': directives.unchanged_required, + 'skipif': directives.unchanged_required, } @@ -182,6 +194,7 @@ class TestoutputDirective(TestDirective): 'hide': directives.flag, 'options': directives.unchanged, 'pyversion': directives.unchanged_required, + 'skipif': directives.unchanged_required, } From 827dbea009b795ae9760cd3e3527d8edee037cf5 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 7 Aug 2018 23:17:59 +0900 Subject: [PATCH 106/174] Use typing.Any for config type hinting instead --- sphinx/config.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/sphinx/config.py b/sphinx/config.py index 7785423c7..ec54f1691 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -49,10 +49,6 @@ ConfigValue = NamedTuple('ConfigValue', [('name', str), ('rebuild', Union[bool, unicode])]) -#: represents the config value accepts any type of value. -Any = object() - - class ENUM(object): """represents the config value should be a one of candidates. From 67760128c2e224753272e4f8c4b6876c0483ee0f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 7 Aug 2018 23:17:42 +0900 Subject: [PATCH 107/174] refactor: Move settings for pLaTeX to ADDITIONAL_SETTINGS --- sphinx/writers/latex.py | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 40a69f1c1..1cd5d1d7e 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -177,6 +177,9 @@ ADDITIONAL_SETTINGS = { }, 'platex': { 'latex_engine': 'platex', + 'babel': '', + 'classoptions': ',dvipdfmx', + 'fncychap': '', 'geometry': '\\usepackage[dvipdfm]{geometry}', }, } # type: Dict[unicode, Dict[unicode, unicode]] @@ -570,8 +573,8 @@ class LaTeXTranslator(nodes.NodeVisitor): self.elements['logo'] = '\\sphinxincludegraphics{%s}\\par' % \ path.basename(builder.config.latex_logo) - if builder.config.language \ - and 'fncychap' not in builder.config.latex_elements: + if (builder.config.language and builder.config.language != 'ja' and + 'fncychap' not in builder.config.latex_elements): # use Sonny style if any language specified self.elements['fncychap'] = ('\\usepackage[Sonny]{fncychap}\n' '\\ChNameVar{\\Large\\normalfont' @@ -586,13 +589,10 @@ class LaTeXTranslator(nodes.NodeVisitor): logger.warning(__('no Babel option known for language %r'), builder.config.language) - # simply use babel.get_language() always, as get_language() returns - # 'english' even if language is invalid or empty - self.elements['classoptions'] += ',' + self.babel.get_language() - # set up multilingual module... # 'babel' key is public and user setting must be obeyed if self.elements['babel']: + self.elements['classoptions'] += ',' + self.babel.get_language() # this branch is not taken for xelatex/lualatex if default settings self.elements['multilingual'] = self.elements['babel'] if builder.config.language: @@ -602,18 +602,8 @@ class LaTeXTranslator(nodes.NodeVisitor): if self.babel.uses_cyrillic() \ and 'fontpkg' not in builder.config.latex_elements: self.elements['fontpkg'] = '' - - # pTeX (Japanese TeX) for support - if builder.config.language == 'ja': - # use dvipdfmx as default class option in Japanese - self.elements['classoptions'] = ',dvipdfmx' - # disable babel which has not publishing quality in Japanese - self.elements['babel'] = '' - self.elements['shorthandoff'] = '' - self.elements['multilingual'] = '' - # disable fncychap in Japanese documents - self.elements['fncychap'] = '' elif self.elements['polyglossia']: + self.elements['classoptions'] += ',' + self.babel.get_language() options = self.babel.get_mainlanguage_options() if options: mainlanguage = r'\setmainlanguage[%s]{%s}' % (options, From 8c050956e36472a573f3b32016b3650f881f7a18 Mon Sep 17 00:00:00 2001 From: linnekback Date: Thu, 9 Aug 2018 13:15:37 +0200 Subject: [PATCH 108/174] #5278: re-format links --- EXAMPLES | 1013 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 662 insertions(+), 351 deletions(-) diff --git a/EXAMPLES b/EXAMPLES index e988a9965..e20c967cb 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -12,400 +12,711 @@ interesting examples. Documentation using the alabaster theme --------------------------------------- -* Alabaster: https://alabaster.readthedocs.io/ -* Blinker: https://pythonhosted.org/blinker/ -* Calibre: https://manual.calibre-ebook.com/ -* Click: http://click.pocoo.org/ (customized) -* coala: https://docs.coala.io/ (customized) -* CodePy: https://documen.tician.de/codepy/ -* Fabric: http://docs.fabfile.org/ -* Fityk: http://fityk.nieto.pl/ -* Flask: http://flask.pocoo.org/docs/ -* Flask-OpenID: https://pythonhosted.org/Flask-OpenID/ -* Invoke: http://docs.pyinvoke.org/ -* Jinja: http://jinja.pocoo.org/docs/ -* Lino: http://www.lino-framework.org/ (customized) -* marbl: https://getmarbl.readthedocs.io/ -* MDAnalysis: http://www.mdanalysis.org/docs/ (customized) -* MeshPy: https://documen.tician.de/meshpy/ -* PyCUDA: https://documen.tician.de/pycuda/ -* PyOpenCL: https://documen.tician.de/pyopencl/ -* PyLangAcq: http://pylangacq.org/ -* pytest: https://docs.pytest.org/ (customized) -* python-apt: https://apt.alioth.debian.org/python-apt-doc/ -* PyVisfile: https://documen.tician.de/pyvisfile/ -* Requests: http://www.python-requests.org/ -* searx: https://asciimoo.github.io/searx/ -* Spyder: https://docs.spyder-ide.org/ (customized) -* Tablib: http://docs.python-tablib.org/ -* urllib3: https://urllib3.readthedocs.io/ (customized) -* Werkzeug: http://werkzeug.pocoo.org/docs/ (customized) +* `Alabaster`__ +* `Blinker`__ +* `Calibre`__ +* `Click`__ (customized) +* `coala`__ (customized) +* `CodePy`__ +* `Fabric`__ +* `Fityk`__ +* `Flask`__ +* `Flask-OpenID`__ +* `Invoke`__ +* `Jinja`__ +* `Lino`__ (customized) +* `marbl`__ +* `MDAnalysis`__ (customized) +* `MeshPy`__ +* `PyCUDA`__ +* `PyOpenCL`__ +* `PyLangAcq`__ +* `pytest`__ (customized) +* `python-apt`__ +* `PyVisfile`__ +* `Requests`__ +* `searx`__ +* `Spyder`__ (customized) +* `Tablib`__ +* `urllib3`__ (customized) +* `Werkzeug`__ (customized) + +__ https://alabaster.readthedocs.io/ +__ https://pythonhosted.org/blinker/ +__ https://manual.calibre-ebook.com/ +__ http://click.pocoo.org/ +__ https://docs.coala.io/ +__ https://documen.tician.de/codepy/ +__ http://docs.fabfile.org/ +__ http://fityk.nieto.pl/ +__ http://flask.pocoo.org/docs/ +__ https://pythonhosted.org/Flask-OpenID/ +__ http://docs.pyinvoke.org/ +__ http://jinja.pocoo.org/docs/ +__ http://www.lino-framework.org/ +__ https://getmarbl.readthedocs.io/ +__ http://www.mdanalysis.org/docs/ +__ https://documen.tician.de/meshpy/ +__ https://documen.tician.de/pycuda/ +__ https://documen.tician.de/pyopencl/ +__ http://pylangacq.org/ +__ https://docs.pytest.org/ +__ https://apt.alioth.debian.org/python-apt-doc/ +__ https://documen.tician.de/pyvisfile/ +__ http://www.python-requests.org/ +__ https://asciimoo.github.io/searx/ +__ https://docs.spyder-ide.org/ +__ http://docs.python-tablib.org/ +__ https://urllib3.readthedocs.io/ +__ http://werkzeug.pocoo.org/docs/ Documentation using the classic theme ------------------------------------- -* Advanced Generic Widgets: http://xoomer.virgilio.it/infinity77/AGW_Docs/ (customized) -* Apache CouchDB: http://docs.couchdb.org/ (customized) -* APSW: https://rogerbinns.github.io/apsw/ -* Arb: http://arblib.org/ -* Bazaar: http://doc.bazaar.canonical.com/ (customized) -* Beautiful Soup: https://www.crummy.com/software/BeautifulSoup/bs4/doc/ -* Blender: https://docs.blender.org/api/current/ -* Bugzilla: https://bugzilla.readthedocs.io/ -* Buildbot: https://docs.buildbot.net/latest/ -* CMake: https://cmake.org/documentation/ (customized) -* Chaco: http://docs.enthought.com/chaco/ (customized) -* Cormoran: http://cormoran.nhopkg.org/docs/ -* DEAP: https://deap.readthedocs.io/ (customized) -* Director: https://pythonhosted.org/director/ -* EZ-Draw: https://pageperso.lif.univ-mrs.fr/~edouard.thiel/ez-draw/doc/en/html/ez-manual.html (customized) -* F2py: http://f2py.sourceforge.net/docs/ -* Generic Mapping Tools (GMT): http://gmt.soest.hawaii.edu/doc/latest/ (customized) -* Genomedata: https://noble.gs.washington.edu/proj/genomedata/doc/1.3.3/ -* GetFEM++: http://getfem.org/ (customized) -* Glasgow Haskell Compiler: https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/ (customized) -* Grok: http://grok.zope.org/doc/current/ (customized) -* GROMACS: http://manual.gromacs.org/documentation/ -* GSL Shell: http://www.nongnu.org/gsl-shell/ -* Hands-on Python Tutorial: http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/ -* Kaa: http://api.freevo.org/kaa-base/ (customized) -* Leo: http://leoeditor.com/ -* LEPL: http://www.acooke.org/lepl/ (customized) -* Mayavi: http://docs.enthought.com/mayavi/mayavi/ (customized) -* MediaGoblin: https://mediagoblin.readthedocs.io/ (customized) -* mpmath: http://mpmath.org/doc/current/ -* OpenCV: http://docs.opencv.org/ (customized) -* OpenEXR: http://excamera.com/articles/26/doc/index.html -* OpenGDA: http://www.opengda.org/gdadoc/html/ -* Peach^3: https://peach3.nl/doc/latest/userdoc/ (customized) -* Plone: https://docs.plone.org/ (customized) -* PyEMD: https://pyemd.readthedocs.io/ -* Pyevolve: http://pyevolve.sourceforge.net/ -* Pygame: https://www.pygame.org/docs/ (customized) -* PyMQI: https://pythonhosted.org/pymqi/ -* PyQt4: http://pyqt.sourceforge.net/Docs/PyQt4/ (customized) -* PyQt5: http://pyqt.sourceforge.net/Docs/PyQt5/ (customized) -* Python 2: https://docs.python.org/2/ -* Python 3: https://docs.python.org/3/ (customized) -* Python Packaging Authority: https://www.pypa.io/ (customized) -* Ring programming language: http://ring-lang.sourceforge.net/doc/ (customized) -* SageMath: https://doc.sagemath.org/ (customized) -* Segway: http://noble.gs.washington.edu/proj/segway/doc/1.1.0/segway.html -* simuPOP: http://simupop.sourceforge.net/manual_release/build/userGuide.html (customized) -* Sprox: http://sprox.org/ (customized) -* SymPy: http://docs.sympy.org/ -* TurboGears: https://turbogears.readthedocs.io/ (customized) -* tvtk: http://docs.enthought.com/mayavi/tvtk/ -* Varnish: https://www.varnish-cache.org/docs/ (customized, alabaster for index) -* Waf: https://waf.io/apidocs/ -* wxPython Phoenix: https://wxpython.org/Phoenix/docs/html/main.html (customized) -* z3c: http://www.ibiblio.org/paulcarduner/z3ctutorial/ -* zc.async: https://pythonhosted.org/zc.async/ (customized) -* Zope: https://docs.zope.org/zope2/ (customized) +* `Advanced Generic Widgets`__ (customized) +* `Apache CouchDB`__ (customized) +* `APSW`__ +* `Arb`__ +* `Bazaar`__ (customized) +* `Beautiful Soup`__ +* `Blender`__ +* `Bugzilla`__ +* `Buildbot`__ +* `CMake`__ (customized) +* `Chaco`__ (customized) +* `Cormoran`__ +* `DEAP`__ (customized) +* `Director`__ +* `EZ-Draw`__ (customized) +* `F2py`__ +* `Generic Mapping Tools (GMT)`__ (customized) +* `Genomedata`__ +* `GetFEM++`__ (customized) +* `Glasgow Haskell Compiler`__ (customized) +* `Grok`__ (customized) +* `GROMACS`__ +* `GSL Shell`__ +* `Hands-on Python Tutorial`__ +* `Kaa`__ (customized) +* `Leo`__ +* `LEPL`__ (customized) +* `Mayavi`__ (customized) +* `MediaGoblin`__ (customized) +* `mpmath`__ +* `OpenCV`__ (customized) +* `OpenEXR`__ +* `OpenGDA`__ +* `Peach^3`__ (customized) +* `Plone`__ (customized) +* `PyEMD`__ +* `Pyevolve`__ +* `Pygame`__ (customized) +* `PyMQI`__ +* `PyQt4`__ (customized) +* `PyQt5`__ (customized) +* `Python 2`__ +* `Python 3`__ (customized) +* `Python Packaging Authority`__ (customized) +* `Ring programming language`__ (customized) +* `SageMath`__ (customized) +* `Segway`__ +* `simuPOP`__ (customized) +* `Sprox`__ (customized) +* `SymPy`__ +* `TurboGears`__ (customized) +* `tvtk`__ +* `Varnish`__ (customized, alabaster for index) +* `Waf`__ +* `wxPython Phoenix`__ (customized) +* `z3c`__ +* `zc.async`__ (customized) +* `Zope`__ (customized) + +__ http://xoomer.virgilio.it/infinity77/AGW_Docs/ +__ http://docs.couchdb.org/ +__ https://rogerbinns.github.io/apsw/ +__ http://arblib.org/ +__ http://doc.bazaar.canonical.com/ +__ https://www.crummy.com/software/BeautifulSoup/bs4/doc/ +__ https://docs.blender.org/api/current/ +__ https://bugzilla.readthedocs.io/ +__ https://docs.buildbot.net/latest/ +__ https://cmake.org/documentation/ +__ http://docs.enthought.com/chaco/ +__ http://cormoran.nhopkg.org/docs/ +__ https://deap.readthedocs.io/ +__ https://deap.readthedocs.io/ +__ https://pythonhosted.org/director/ +__ https://pageperso.lif.univ-mrs.fr/~edouard.thiel/ez-draw/doc/en/html/ez-manual.html +__ http://f2py.sourceforge.net/docs/ +__ http://gmt.soest.hawaii.edu/doc/latest/ +__ https://noble.gs.washington.edu/proj/genomedata/doc/1.3.3/ +__ http://getfem.org/ +__ https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/ +__ http://grok.zope.org/doc/current/ +__ http://manual.gromacs.org/documentation/ +__ http://www.nongnu.org/gsl-shell/ +__ http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/ +__ http://api.freevo.org/kaa-base/ +__ http://leoeditor.com/ +__ http://www.acooke.org/lepl/ +__ http://docs.enthought.com/mayavi/mayavi/ +__ https://mediagoblin.readthedocs.io/ +__ http://mpmath.org/doc/current/ +__ http://docs.opencv.org/ +__ http://excamera.com/articles/26/doc/index.html +__ http://www.opengda.org/gdadoc/html/ +__ https://peach3.nl/doc/latest/userdoc/ +__ https://docs.plone.org/ +__ https://pyemd.readthedocs.io/ +__ http://pyevolve.sourceforge.net/ +__ https://www.pygame.org/docs/ +__ https://pythonhosted.org/pymqi/ +__ http://pyqt.sourceforge.net/Docs/PyQt4/ +__ http://pyqt.sourceforge.net/Docs/PyQt5/ +__ https://docs.python.org/2/ +__ https://docs.python.org/3/ +__ https://www.pypa.io/ +__ http://ring-lang.sourceforge.net/doc/ +__ https://doc.sagemath.org/ +__ http://noble.gs.washington.edu/proj/segway/doc/1.1.0/segway.html +__ http://simupop.sourceforge.net/manual_release/build/userGuide.html +__ http://sprox.org/ +__ http://docs.sympy.org/ +__ https://turbogears.readthedocs.io/ +__ http://docs.enthought.com/mayavi/tvtk/ +__ https://www.varnish-cache.org/docs/ +__ https://waf.io/apidocs/ +__ https://wxpython.org/Phoenix/docs/html/main.html +__ http://www.ibiblio.org/paulcarduner/z3ctutorial/ +__ https://pythonhosted.org/zc.async/ +__ https://docs.zope.org/zope2/ Documentation using the sphinxdoc theme --------------------------------------- -* cartopy: http://scitools.org.uk/cartopy/docs/latest/ -* Jython: http://www.jython.org/docs/ -* Matplotlib: https://matplotlib.org/ -* MDAnalysis Tutorial: http://www.mdanalysis.org/MDAnalysisTutorial/ -* NetworkX: https://networkx.github.io/ -* PyCantonese: http://pycantonese.org/ -* Pyre: http://docs.danse.us/pyre/sphinx/ -* pySPACE: https://pyspace.github.io/pyspace/ -* Pysparse: http://pysparse.sourceforge.net/ -* PyTango: - http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango/latest/ -* Python Wild Magic: https://vmlaker.github.io/pythonwildmagic/ (customized) -* Reteisi: http://www.reteisi.org/contents.html (customized) -* Sqlkit: http://sqlkit.argolinux.org/ (customized) -* Turbulenz: http://docs.turbulenz.com/ +* `cartopy`__ +* `Jython`__ +* `Matplotlib`__ +* `MDAnalysis Tutorial`__ +* `NetworkX`__ +* `PyCantonese`__ +* `Pyre`__ +* `pySPACE`__ +* `Pysparse`__ +* `PyTango`__ +* `Python Wild Magic`__ (customized) +* `Reteisi`__ (customized) +* `Sqlkit`__ (customized) +* `Turbulenz`__ + +__ http://scitools.org.uk/cartopy/docs/latest/ +__ http://www.jython.org/docs/ +__ https://matplotlib.org/ +__ http://www.mdanalysis.org/MDAnalysisTutorial/ +__ https://networkx.github.io/ +__ http://pycantonese.org/ +__ http://docs.danse.us/pyre/sphinx/ +__ https://pyspace.github.io/pyspace/ +__ http://pysparse.sourceforge.net/ +__ http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango/latest/ +__ https://vmlaker.github.io/pythonwildmagic/ +__ http://www.reteisi.org/contents.html +__ http://sqlkit.argolinux.org/ +__ http://docs.turbulenz.com/ Documentation using the nature theme ------------------------------------ -* Alembic: http://alembic.zzzcomputing.com/ -* Cython: http://docs.cython.org/ -* easybuild: https://easybuild.readthedocs.io/ -* jsFiddle: http://doc.jsfiddle.net/ -* libLAS: https://www.liblas.org/ (customized) -* Lmod: https://lmod.readthedocs.io/ -* MapServer: http://mapserver.org/ (customized) -* Pandas: https://pandas.pydata.org/pandas-docs/stable/ -* pyglet: https://pyglet.readthedocs.io/ (customized) -* Setuptools: https://setuptools.readthedocs.io/ -* Spring Python: https://docs.spring.io/spring-python/1.2.x/sphinx/html/ -* StatsModels: http://www.statsmodels.org/ (customized) -* Sylli: http://sylli.sourceforge.net/ +* `Alembic`__ +* `Cython`__ +* `easybuild`__ +* `jsFiddle`__ +* `libLAS`__ (customized) +* `Lmod`__ +* `MapServer`__ (customized) +* `Pandas`__ +* `pyglet`__ (customized) +* `Setuptools`__ +* `Spring Python`__ +* `StatsModels`__ (customized) +* `Sylli`__ + +__ http://alembic.zzzcomputing.com/ +__ http://docs.cython.org/ +__ https://easybuild.readthedocs.io/ +__ http://doc.jsfiddle.net/ +__ https://www.liblas.org/ +__ https://lmod.readthedocs.io/ +__ http://mapserver.org/ +__ https://pandas.pydata.org/pandas-docs/stable/ +__ https://pyglet.readthedocs.io/ +__ https://setuptools.readthedocs.io/ +__ https://docs.spring.io/spring-python/1.2.x/sphinx/html/ +__ http://www.statsmodels.org/ +__ http://sylli.sourceforge.net/ Documentation using another builtin theme ----------------------------------------- -* Breathe: https://breathe.readthedocs.io/ (haiku) -* MPipe: https://vmlaker.github.io/mpipe/ (sphinx13) -* NLTK: http://www.nltk.org/ (agogo) -* Programmieren mit PyGTK und Glade (German): - http://www.florian-diesch.de/doc/python-und-glade/online/ (agogo, customized) -* PyPubSub: https://pypubsub.readthedocs.io/ (bizstyle) -* Pylons: http://docs.pylonsproject.org/projects/pylons-webframework/ (pyramid) -* Pyramid web framework: - https://docs.pylonsproject.org/projects/pyramid/ (pyramid) -* Sphinx: http://www.sphinx-doc.org/ (sphinx13) :-) -* Valence: http://docs.valence.desire2learn.com/ (haiku, customized) +* `Breathe`__ (haiku) +* `MPipe`__ (sphinx13) +* `NLTK`__ (agogo) +* `Programmieren mit PyGTK und Glade (German)`__ (agogo, customized) +* `PyPubSub`__ (bizstyle) +* `Pylons`__ (pyramid) +* `Pyramid web framework`__ (pyramid) +* `Sphinx`__ (sphinx13) :-) +* `Valence`__ (haiku, customized) + +__ https://breathe.readthedocs.io/ +__ https://vmlaker.github.io/mpipe/ +__ http://www.nltk.org/ +__ http://www.florian-diesch.de/doc/python-und-glade/online/ +__ https://pypubsub.readthedocs.io/ +__ http://docs.pylonsproject.org/projects/pylons-webframework/ +__ https://docs.pylonsproject.org/projects/pyramid/ +__ http://www.sphinx-doc.org/ +__ http://docs.valence.desire2learn.com/ Documentation using sphinx_rtd_theme ------------------------------------ -* Annotator: http://docs.annotatorjs.org/ -* Ansible: https://docs.ansible.com/ (customized) -* Arcade: http://arcade.academy/ -* aria2: https://aria2.github.io/manual/en/html/ -* ASE: https://wiki.fysik.dtu.dk/ase/ -* Autofac: http://docs.autofac.org/ -* BigchainDB: https://docs.bigchaindb.com/ -* Blocks: https://blocks.readthedocs.io/ -* bootstrap-datepicker: https://bootstrap-datepicker.readthedocs.io/ -* Certbot: https://letsencrypt.readthedocs.io/ -* Chainer: https://docs.chainer.org/ (customized) -* CherryPy: http://docs.cherrypy.org/ -* Chainer: https://docs.chainer.org/ -* CodeIgniter: https://www.codeigniter.com/user_guide/ -* Conda: https://conda.io/docs/ -* Corda: https://docs.corda.net/ -* Dask: https://dask.pydata.org/ -* Databricks: https://docs.databricks.com/ (customized) -* Dataiku DSS: https://doc.dataiku.com/ -* edX: http://docs.edx.org/ -* Electrum: http://docs.electrum.org/ -* Elemental: http://libelemental.org/documentation/dev/ -* ESWP3: https://eswp3.readthedocs.io/ -* Ethereum Homestead: http://www.ethdocs.org/ -* Fidimag: https://fidimag.readthedocs.io/ -* Flake8: http://flake8.pycqa.org/ -* GeoNode: http://docs.geonode.org/ -* Godot: https://godot.readthedocs.io/ -* Graylog: http://docs.graylog.org/ -* GPAW: https://wiki.fysik.dtu.dk/gpaw/ (customized) -* HDF5 for Python (h5py): http://docs.h5py.org/ -* Hyperledger Fabric: https://hyperledger-fabric.readthedocs.io/ -* Hyperledger Sawtooth: https://intelledger.github.io/ -* IdentityServer: http://docs.identityserver.io/ -* Idris: http://docs.idris-lang.org/ -* javasphinx: https://bronto-javasphinx.readthedocs.io/ -* Julia: https://julia.readthedocs.io/ -* Jupyter Notebook: https://jupyter-notebook.readthedocs.io/ -* Lasagne: https://lasagne.readthedocs.io/ -* latexindent.pl: https://latexindentpl.readthedocs.io/ -* Linguistica: https://linguistica-uchicago.github.io/lxa5/ -* Linux kernel: https://www.kernel.org/doc/html/latest/index.html -* MathJax: https://docs.mathjax.org/ -* MDTraj: http://mdtraj.org/latest/ (customized) -* MICrobial Community Analysis (micca): http://micca.org/docs/latest/ -* MicroPython: https://docs.micropython.org/ -* Minds: https://www.minds.org/docs/ (customized) -* Mink: http://mink.behat.org/ -* Mockery: http://docs.mockery.io/ -* mod_wsgi: https://modwsgi.readthedocs.io/ -* MoinMoin: https://moin-20.readthedocs.io/ -* Mopidy: https://docs.mopidy.com/ -* MyHDL: http://docs.myhdl.org/ -* Nextflow: https://www.nextflow.io/docs/latest/index.html -* NICOS: https://forge.frm2.tum.de/nicos/doc/nicos-master/ (customized) -* Pelican: http://docs.getpelican.com/ -* picamera: https://picamera.readthedocs.io/ -* Pillow: https://pillow.readthedocs.io/ -* pip: https://pip.pypa.io/ -* Paver: https://paver.readthedocs.io/ -* peewee: http://docs.peewee-orm.com/ -* Phinx: http://docs.phinx.org/ -* phpMyAdmin: https://docs.phpmyadmin.net/ -* PROS: https://pros.cs.purdue.edu/v5/ (customized) -* Pweave: http://mpastell.com/pweave/ -* PyPy: http://doc.pypy.org/ -* python-sqlparse: https://sqlparse.readthedocs.io/ -* PyVISA: https://pyvisa.readthedocs.io/ -* Read The Docs: https://docs.readthedocs.io/ -* Free your information from their silos (French): - http://redaction-technique.org/ (customized) -* Releases Sphinx extension: https://releases.readthedocs.io/ -* Qtile: http://docs.qtile.org/ -* Quex: http://quex.sourceforge.net/doc/html/main.html -* Satchmo: http://docs.satchmoproject.com/ -* Scapy: https://scapy.readthedocs.io/ -* SimPy: http://simpy.readthedocs.io/ -* SlamData: http://docs.slamdata.com/ -* Solidity: https://solidity.readthedocs.io/ -* Sonos Controller (SoCo): http://docs.python-soco.com/ -* Sphinx AutoAPI: https://sphinx-autoapi.readthedocs.io/ -* sphinx-argparse: https://sphinx-argparse.readthedocs.io/ -* Sphinx-Gallery: https://sphinx-gallery.readthedocs.io/ (customized) -* StarUML: http://docs.staruml.io/ -* Sublime Text Unofficial Documentation: http://docs.sublimetext.info/ -* SunPy: http://docs.sunpy.org/ -* Sylius: http://docs.sylius.org/ -* Tango Controls: https://tango-controls.readthedocs.io/ (customized) -* Topshelf: http://docs.topshelf-project.com/ -* Theano: http://www.deeplearning.net/software/theano/ -* ThreatConnect: https://docs.threatconnect.com/ -* Tuleap: https://tuleap.net/doc/en/ -* TYPO3: https://docs.typo3.org/ (customized) -* uWSGI: https://uwsgi-docs.readthedocs.io/ -* Wagtail: http://docs.wagtail.io/ -* Web Application Attack and Audit Framework (w3af): http://docs.w3af.org/ -* Weblate: https://docs.weblate.org/ -* x265: https://x265.readthedocs.io/ -* ZeroNet: https://zeronet.readthedocs.io/ +* `Annotator`__ +* `Ansible`__ (customized) +* `Arcade`__ +* `aria2`__ +* `ASE`__ +* `Autofac`__ +* `BigchainDB`__ +* `Blocks`__ +* `bootstrap-datepicker`__ +* `Certbot`__ +* `Chainer`__ (customized) +* `CherryPy`__ +* `Chainer`__ +* `CodeIgniter`__ +* `Conda`__ +* `Corda`__ +* `Dask`__ +* `Databricks`__ (customized) +* `Dataiku DSS`__ +* `edX`__ +* `Electrum`__ +* `Elemental`__ +* `ESWP3`__ +* `Ethereum Homestead`__ +* `Fidimag`__ +* `Flake8`__ +* `GeoNode`__ +* `Godot`__ +* `Graylog`__ +* `GPAW`__ (customized) +* `HDF5 for Python (h5py)`__ +* `Hyperledger Fabric`__ +* `Hyperledger Sawtooth`__ +* `IdentityServer`__ +* `Idris`__ +* `javasphinx`__ +* `Julia`__ +* `Jupyter Notebook`__ +* `Lasagne`__ +* `latexindent.pl`__ +* `Linguistica`__ +* `Linux kernel`__ +* `MathJax`__ +* `MDTraj`__ (customized) +* `MICrobial Community Analysis (micca)`__ +* `MicroPython`__ +* `Minds`__ (customized) +* `Mink`__ +* `Mockery`__ +* `mod_wsgi`__ +* `MoinMoin`__ +* `Mopidy`__ +* `MyHDL`__ +* `Nextflow`__ +* `NICOS`__ (customized) +* `Pelican`__ +* `picamera`__ +* `Pillow`__ +* `pip`__ +* `Paver`__ +* `peewee`__ +* `Phinx`__ +* `phpMyAdmin`__ +* `PROS`__ (customized) +* `Pweave`__ +* `PyPy`__ +* `python-sqlparse`__ +* `PyVISA`__ +* `Read The Docs`__ +* `Free your information from their silos (French)`__ (customized) +* `Releases Sphinx extension`__ +* `Qtile`__ +* `Quex`__ +* `Satchmo`__ +* `Scapy`__ +* `SimPy`__ +* `SlamData`__ +* `Solidity`__ +* `Sonos Controller (SoCo)`__ +* `Sphinx AutoAPI`__ +* `sphinx-argparse`__ +* `Sphinx-Gallery`__ (customized) +* `StarUML`__ +* `Sublime Text Unofficial Documentation`__ +* `SunPy`__ +* `Sylius`__ +* `Tango Controls`__ (customized) +* `Topshelf`__ +* `Theano`__ +* `ThreatConnect`__ +* `Tuleap`__ +* `TYPO3`__ (customized) +* `uWSGI`__ +* `Wagtail`__ +* `Web Application Attack and Audit Framework (w3af)`__ +* `Weblate`__ +* `x265`__ +* `ZeroNet`__ + +__ http://docs.annotatorjs.org/ +__ https://docs.ansible.com/ +__ http://arcade.academy/ +__ https://aria2.github.io/manual/en/html/ +__ https://wiki.fysik.dtu.dk/ase/ +__ http://docs.autofac.org/ +__ https://docs.bigchaindb.com/ +__ https://blocks.readthedocs.io/ +__ https://bootstrap-datepicker.readthedocs.io/ +__ https://letsencrypt.readthedocs.io/ +__ https://docs.chainer.org/ +__ http://docs.cherrypy.org/ +__ https://docs.chainer.org/ +__ https://www.codeigniter.com/user_guide/ +__ https://conda.io/docs/ +__ https://docs.corda.net/ +__ https://dask.pydata.org/ +__ https://docs.databricks.com/ +__ https://doc.dataiku.com/ +__ http://docs.edx.org/ +__ http://docs.electrum.org/ +__ http://libelemental.org/documentation/dev/ +__ https://eswp3.readthedocs.io/ +__ http://www.ethdocs.org/ +__ https://fidimag.readthedocs.io/ +__ http://flake8.pycqa.org/ +__ http://docs.geonode.org/ +__ https://godot.readthedocs.io/ +__ http://docs.graylog.org/ +__ https://wiki.fysik.dtu.dk/gpaw/ +__ http://docs.h5py.org/ +__ https://hyperledger-fabric.readthedocs.io/ +__ https://intelledger.github.io/ +__ http://docs.identityserver.io/ +__ http://docs.idris-lang.org/ +__ https://bronto-javasphinx.readthedocs.io/ +__ https://julia.readthedocs.io/ +__ https://jupyter-notebook.readthedocs.io/ +__ https://lasagne.readthedocs.io/ +__ https://latexindentpl.readthedocs.io/ +__ https://linguistica-uchicago.github.io/lxa5/ +__ https://www.kernel.org/doc/html/latest/index.html +__ https://docs.mathjax.org/ +__ http://mdtraj.org/latest/ +__ http://micca.org/docs/latest/ +__ https://docs.micropython.org/ +__ https://www.minds.org/docs/ +__ http://mink.behat.org/ +__ http://docs.mockery.io/ +__ https://modwsgi.readthedocs.io/ +__ https://moin-20.readthedocs.io/ +__ https://docs.mopidy.com/ +__ http://docs.myhdl.org/ +__ https://www.nextflow.io/docs/latest/index.html +__ https://forge.frm2.tum.de/nicos/doc/nicos-master/ +__ http://docs.getpelican.com/ +__ https://picamera.readthedocs.io/ +__ https://pillow.readthedocs.io/ +__ https://pip.pypa.io/ +__ https://paver.readthedocs.io/ +__ http://docs.peewee-orm.com/ +__ http://docs.phinx.org/ +__ https://docs.phpmyadmin.net/ +__ https://pros.cs.purdue.edu/v5/ +__ http://mpastell.com/pweave/ +__ http://doc.pypy.org/ +__ https://sqlparse.readthedocs.io/ +__ https://pyvisa.readthedocs.io/ +__ https://docs.readthedocs.io/ +__ http://redaction-technique.org/ +__ https://releases.readthedocs.io/ +__ http://docs.qtile.org/ +__ http://quex.sourceforge.net/doc/html/main.html +__ http://docs.satchmoproject.com/ +__ https://scapy.readthedocs.io/ +__ http://simpy.readthedocs.io/ +__ http://docs.slamdata.com/ +__ https://solidity.readthedocs.io/ +__ http://docs.python-soco.com/ +__ https://sphinx-autoapi.readthedocs.io/ +__ https://sphinx-argparse.readthedocs.io/ +__ https://sphinx-gallery.readthedocs.io/ +__ http://docs.staruml.io/ +__ http://docs.sublimetext.info/ +__ http://docs.sunpy.org/ +__ http://docs.sylius.org/ +__ https://tango-controls.readthedocs.io/ +__ http://docs.topshelf-project.com/ +__ http://www.deeplearning.net/software/theano/ +__ https://docs.threatconnect.com/ +__ https://tuleap.net/doc/en/ +__ https://docs.typo3.org/ +__ https://uwsgi-docs.readthedocs.io/ +__ http://docs.wagtail.io/ +__ http://docs.w3af.org/ +__ https://docs.weblate.org/ +__ https://x265.readthedocs.io/ +__ https://zeronet.readthedocs.io/ Documentation using sphinx_bootstrap_theme ------------------------------------------ -* Bootstrap Theme: https://ryan-roemer.github.io/sphinx-bootstrap-theme/ -* C/C++ Software Development with Eclipse: http://eclipsebook.in/ -* Dataverse: http://guides.dataverse.org/ -* e-cidadania: https://e-cidadania.readthedocs.io/ -* Hangfire: http://docs.hangfire.io/ -* Hedge: https://documen.tician.de/hedge/ -* ObsPy: https://docs.obspy.org/ -* Open Dylan: https://opendylan.org/documentation/ -* Pootle: http://docs.translatehouse.org/projects/pootle/ -* PyUblas: https://documen.tician.de/pyublas/ -* seaborn: https://seaborn.pydata.org/ +* `Bootstrap Theme`__ +* `C/C++ Software Development with Eclipse`__ +* `Dataverse`__ +* `e-cidadania`__ +* `Hangfire`__ +* `Hedge`__ +* `ObsPy`__ +* `Open Dylan`__ +* `Pootle`__ +* `PyUblas`__ +* `seaborn`__ + +__ https://ryan-roemer.github.io/sphinx-bootstrap-theme/ +__ http://eclipsebook.in/ +__ http://guides.dataverse.org/ +__ https://e-cidadania.readthedocs.io/ +__ http://docs.hangfire.io/ +__ https://documen.tician.de/hedge/ +__ https://docs.obspy.org/ +__ https://opendylan.org/documentation/ +__ http://docs.translatehouse.org/projects/pootle/ +__ https://documen.tician.de/pyublas/ +__ https://seaborn.pydata.org/ Documentation using a custom theme or integrated in a website ------------------------------------------------------------- -* Apache Cassandra: https://cassandra.apache.org/doc/ -* Astropy: http://docs.astropy.org/ -* Bokeh: https://bokeh.pydata.org/ -* Boto 3: https://boto3.readthedocs.io/ -* CakePHP: https://book.cakephp.org/ -* CasperJS: http://docs.casperjs.org/ -* Ceph: http://docs.ceph.com/docs/master/ -* Chef: https://docs.chef.io/ -* CKAN: http://docs.ckan.org/ -* Confluent Platform: http://docs.confluent.io/ -* Django: https://docs.djangoproject.com/ -* Doctrine: http://docs.doctrine-project.org/ -* Enterprise Toolkit for Acrobat products: - https://www.adobe.com/devnet-docs/acrobatetk/ -* Gameduino: http://excamera.com/sphinx/gameduino/ -* gensim: https://radimrehurek.com/gensim/ -* GeoServer: http://docs.geoserver.org/ -* gevent: http://www.gevent.org/ -* GHC - Glasgow Haskell Compiler: http://downloads.haskell.org/~ghc/master/users-guide/ -* Guzzle: http://docs.guzzlephp.org/en/stable/ -* H2O.ai: http://docs.h2o.ai/ -* Istihza (Turkish Python documentation project): https://belgeler.yazbel.com/python-istihza/ -* Kombu: http://docs.kombu.me/ -* Lasso: http://lassoguide.com/ -* Mako: http://docs.makotemplates.org/ -* MirrorBrain: http://mirrorbrain.org/docs/ -* MongoDB: https://docs.mongodb.com/ -* Music21: http://web.mit.edu/music21/doc/ -* MyHDL: http://docs.myhdl.org/en/latest/ -* nose: https://nose.readthedocs.io/ -* ns-3: https://www.nsnam.org/documentation/ -* NumPy: https://docs.scipy.org/doc/numpy/reference/ -* ObjectListView: http://objectlistview.sourceforge.net/python/ -* OpenERP: https://doc.odoo.com/ -* OpenCV: http://docs.opencv.org/ -* OpenLayers: http://docs.openlayers.org/ -* OpenTURNS: http://openturns.github.io/openturns/master/ -* Open vSwitch: http://docs.openvswitch.org/ -* PlatformIO: http://docs.platformio.org/ -* PyEphem: http://rhodesmill.org/pyephem/ -* Pygments: http://pygments.org/docs/ -* Plone User Manual (German): https://www.hasecke.com/plone-benutzerhandbuch/4.0/ -* PSI4: http://www.psicode.org/psi4manual/master/index.html -* PyMOTW: https://pymotw.com/2/ -* python-aspectlib: https://python-aspectlib.readthedocs.io/ - (`sphinx_py3doc_enhanced_theme `__) -* QGIS: https://qgis.org/en/docs/index.html -* qooxdoo: http://www.qooxdoo.org/current/ -* Roundup: http://www.roundup-tracker.org/ -* SaltStack: https://docs.saltstack.com/ -* scikit-learn: http://scikit-learn.org/stable/ -* SciPy: https://docs.scipy.org/doc/scipy/refrence/ -* Scrapy: https://doc.scrapy.org/ -* Seaborn: https://seaborn.pydata.org/ -* Selenium: http://docs.seleniumhq.org/docs/ -* Self: http://www.selflanguage.org/ -* Substance D: https://docs.pylonsproject.org/projects/substanced/ -* Sulu: http://docs.sulu.io/ -* SQLAlchemy: https://docs.sqlalchemy.org/ -* tinyTiM: http://tinytim.sourceforge.net/docs/2.0/ -* Twisted: http://twistedmatrix.com/documents/current/ -* Ubuntu Packaging Guide: http://packaging.ubuntu.com/html/ -* WebFaction: https://docs.webfaction.com/ -* WTForms: https://wtforms.readthedocs.io/ +* `Apache Cassandra`__ +* `Astropy`__ +* `Bokeh`__ +* `Boto 3`__ +* `CakePHP`__ +* `CasperJS`__ +* `Ceph`__ +* `Chef`__ +* `CKAN`__ +* `Confluent Platform`__ +* `Django`__ +* `Doctrine`__ +* `Enterprise Toolkit for Acrobat products`__ +* `Gameduino`__ +* `gensim`__ +* `GeoServer`__ +* `gevent`__ +* `GHC - Glasgow Haskell Compiler`__ +* `Guzzle`__ +* `H2O.ai`__ +* `Istihza (Turkish Python documentation project)`__ +* `Kombu`__ +* `Lasso`__ +* `Mako`__ +* `MirrorBrain`__ +* `MongoDB`__ +* `Music21`__ +* `MyHDL`__ +* `nose`__ +* `ns-3`__ +* `NumPy`__ +* `ObjectListView`__ +* `OpenERP`__ +* `OpenCV`__ +* `OpenLayers`__ +* `OpenTURNS`__ +* `Open vSwitch`__ +* `PlatformIO`__ +* `PyEphem`__ +* `Pygments`__ +* `Plone User Manual (German)`__ +* `PSI4`__ +* `PyMOTW`__ +* `python-aspectlib`__ (`sphinx_py3doc_enhanced_theme `__) +* `QGIS`__ +* `qooxdoo`__ +* `Roundup`__ +* `SaltStack`__ +* `scikit-learn`__ +* `SciPy`__ +* `Scrapy`__ +* `Seaborn`__ +* `Selenium`__ +* `Self`__ +* `Substance D`__ +* `Sulu`__ +* `SQLAlchemy`__ +* `tinyTiM`__ +* `Twisted`__ +* `Ubuntu Packaging Guide`__ +* `WebFaction`__ +* `WTForms`__ + +__ https://cassandra.apache.org/doc/ +__ http://docs.astropy.org/ +__ https://bokeh.pydata.org/ +__ https://boto3.readthedocs.io/ +__ https://book.cakephp.org/ +__ http://docs.casperjs.org/ +__ http://docs.ceph.com/docs/master/ +__ https://docs.chef.io/ +__ http://docs.ckan.org/ +__ http://docs.confluent.io/ +__ https://docs.djangoproject.com/ +__ http://docs.doctrine-project.org/ +__ https://www.adobe.com/devnet-docs/acrobatetk/ +__ http://excamera.com/sphinx/gameduino/ +__ https://radimrehurek.com/gensim/ +__ http://docs.geoserver.org/ +__ http://www.gevent.org/ +__ http://downloads.haskell.org/~ghc/master/users-guide/ +__ http://docs.guzzlephp.org/en/stable/ +__ http://docs.h2o.ai/ +__ https://belgeler.yazbel.com/python-istihza/ +__ http://docs.kombu.me/ +__ http://lassoguide.com/ +__ http://docs.makotemplates.org/ +__ http://mirrorbrain.org/docs/ +__ https://docs.mongodb.com/ +__ http://web.mit.edu/music21/doc/ +__ http://docs.myhdl.org/en/latest/ +__ https://nose.readthedocs.io/ +__ https://www.nsnam.org/documentation/ +__ https://docs.scipy.org/doc/numpy/reference/ +__ http://objectlistview.sourceforge.net/python/ +__ https://doc.odoo.com/ +__ http://docs.opencv.org/ +__ http://docs.openlayers.org/ +__ http://openturns.github.io/openturns/master/ +__ http://docs.openvswitch.org/ +__ http://docs.platformio.org/ +__ http://rhodesmill.org/pyephem/ +__ http://pygments.org/docs/ +__ https://www.hasecke.com/plone-benutzerhandbuch/4.0/ +__ http://www.psicode.org/psi4manual/master/index.html +__ https://pymotw.com/2/ +__ https://python-aspectlib.readthedocs.io/ +__ https://qgis.org/en/docs/index.html +__ http://www.qooxdoo.org/current/ +__ http://www.roundup-tracker.org/ +__ https://docs.saltstack.com/ +__ http://scikit-learn.org/stable/ +__ https://docs.scipy.org/doc/scipy/refrence/ +__ https://doc.scrapy.org/ +__ https://seaborn.pydata.org/ +__ http://docs.seleniumhq.org/docs/ +__ http://www.selflanguage.org/ +__ https://docs.pylonsproject.org/projects/substanced/ +__ http://docs.sulu.io/ +__ https://docs.sqlalchemy.org/ +__ http://tinytim.sourceforge.net/docs/2.0/ +__ http://twistedmatrix.com/documents/current/ +__ http://packaging.ubuntu.com/html/ +__ https://docs.webfaction.com/ +__ https://wtforms.readthedocs.io/ Homepages and other non-documentation sites ------------------------------------------- -* Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio- - and Nanophysics: - https://becksteinlab.physics.asu.edu/pages/courses/2013/SimBioNano/ (classic) -* Benoit Boissinot: https://bboissin.appspot.com/ (classic, customized) -* Computer Networks, Parallelization, and Simulation Laboratory (CNPSLab): - https://lab.miletic.net/ (sphinx_rtd_theme) -* Deep Learning Tutorials: http://www.deeplearning.net/tutorial/ (sphinxdoc) -* Loyola University Chicago COMP 339-439 Distributed Systems course: - http://books.cs.luc.edu/distributedsystems/ (sphinx_bootstrap_theme) -* Pylearn2: http://www.deeplearning.net/software/pylearn2/ (sphinxdoc, customized) -* SciPy Cookbook: https://scipy-cookbook.readthedocs.io/ (sphinx_rtd_theme) -* The Wine Cellar Book: https://www.thewinecellarbook.com/doc/en/ (sphinxdoc) -* Thomas Cokelaer's Python, Sphinx and reStructuredText tutorials: - http://thomas-cokelaer.info/tutorials/ (standard) -* UC Berkeley ME233 Advanced Control Systems II course: - https://berkeley-me233.github.io/ (sphinxdoc) +* `Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio-and Nanophysics`__ (classic) +* `Benoit Boissinot`__ (classic, customized) +* `Computer Networks, Parallelization, and Simulation Laboratory (CNPSLab)`__ (sphinx_rtd_theme) +* `Deep Learning Tutorials`__ (sphinxdoc) +* `Loyola University Chicago COMP 339-439 Distributed Systems course´__ (sphinx_bootstrap_theme) +* `Pylearn2`__ (sphinxdoc, customized) +* `SciPy Cookbook`__ (sphinx_rtd_theme) +* `The Wine Cellar Book`__ (sphinxdoc) +* `Thomas Cokelaer's Python, Sphinx and reStructuredText tutorials`__ (standard) +* `UC Berkeley ME233 Advanced Control Systems II course`__ (sphinxdoc) + +__ https://becksteinlab.physics.asu.edu/pages/courses/2013/SimBioNano/ +__ https://bboissin.appspot.com/ +__ https://lab.miletic.net/ +__ http://www.deeplearning.net/tutorial/ +__ http://books.cs.luc.edu/distributedsystems/ +__ http://www.deeplearning.net/software/pylearn2/ +__ https://scipy-cookbook.readthedocs.io/ +__ https://www.thewinecellarbook.com/doc/en/ +__ http://thomas-cokelaer.info/tutorials/ +__ https://berkeley-me233.github.io/ Books produced using Sphinx --------------------------- -* "Die Wahrheit des Sehens. Der DEKALOG von Krzysztof Kieślowski": - https://literatur.hasecke.com/post/die-wahrheit-des-sehens-dekalog-kieslowski/ -* "Expert Python Programming": - https://www.packtpub.com/application-development/expert-python-programming -* "Expert Python Programming" (Japanese translation): - https://www.amazon.co.jp/dp/4048686291/ -* "The Hitchhiker's Guide to Python": http://docs.python-guide.org/en/latest/ -* "LassoGuide": http://www.lassosoft.com/Lasso-Documentation -* "Learning Sphinx" (in Japanese): - https://www.oreilly.co.jp/books/9784873116488/ -* "Mercurial: the definitive guide (Second edition)": - https://book.mercurial-scm.org/ -* "Pioneers and Prominent Men of Utah": http://pioneers.rstebbing.com/ -* "Pomodoro Technique Illustrated" (Japanese translation): - https://www.amazon.co.jp/dp/4048689525/ -* "Python Professional Programming" (in Japanese): - http://www.amazon.co.jp/dp/4798032948/ -* "The ``repoze.bfg`` Web Application Framework": - https://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379 -* "Simple and Steady Way of Learning for Software Engineering" (in Japanese): - https://www.amazon.co.jp/dp/477414259X/ -* "Software-Dokumentation mit Sphinx": https://www.amazon.de/dp/1497448689/ -* "Theoretical Physics Reference": http://www.theoretical-physics.net/ -* "The Varnish Book": - https://info.varnish-software.com/the-varnish-book +* `"Die Wahrheit des Sehens. Der DEKALOG von Krzysztof Kieślowski"`__ +* `"Expert Python Programming"`__ +* `"Expert Python Programming" (Japanese translation)`__ +* `"The Hitchhiker's Guide to Python"`__ +* `"LassoGuide"`__ +* `"Learning Sphinx" (in Japanese)`__ +* `"Mercurial`__ the definitive guide (Second edition)"`__ +* `"Pioneers and Prominent Men of Utah"`__ +* `"Pomodoro Technique Illustrated" (Japanese translation)`__ +* `"Python Professional Programming" (in Japanese)`__ +* `"The ``repoze.bfg`` Web Application Framework"`__ +* `"Simple and Steady Way of Learning for Software Engineering" (in Japanese)`__ +* `"Software-Dokumentation mit Sphinx"`__ +* `"Theoretical Physics Reference"`__ +* `"The Varnish Book"`__ + +__ https://literatur.hasecke.com/post/die-wahrheit-des-sehens-dekalog-kieslowski/ +__ https://www.packtpub.com/application-development/expert-python-programming +__ https://www.amazon.co.jp/dp/4048686291/ +__ http://docs.python-guide.org/en/latest/ +__ http://www.lassosoft.com/Lasso-Documentation +__ https://www.oreilly.co.jp/books/9784873116488/ +__ https://book.mercurial-scm.org/ +__ http://pioneers.rstebbing.com/ +__ https://www.amazon.co.jp/dp/4048689525/ +__ http://www.amazon.co.jp/dp/4798032948/ +__ https://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379 +__ https://www.amazon.co.jp/dp/477414259X/ +__ https://www.amazon.de/dp/1497448689/ +__ http://www.theoretical-physics.net/ +__ https://info.varnish-software.com/the-varnish-book Theses produced using Sphinx ---------------------------- -* "A Web-Based System for Comparative Analysis of OpenStreetMap Data by the Use - of CouchDB": - https://www.yumpu.com/et/document/view/11722645/masterthesis-markusmayr-0542042 -* "Content Conditioning and Distribution for Dynamic Virtual Worlds": - https://www.cs.princeton.edu/research/techreps/TR-941-12 -* "The Sphinx Thesis Resource": https://jterrace.github.io/sphinxtr/ +* `"A Web-Based System for Comparative Analysis of OpenStreetMap Data by the Use + of CouchDB"`__ +* `"Content Conditioning and Distribution for Dynamic Virtual Worlds"`__ +* `"The Sphinx Thesis Resource"`__ + +__ https://www.yumpu.com/et/document/view/11722645/masterthesis-markusmayr-0542042 +__ https://www.cs.princeton.edu/research/techreps/TR-941-12 +__ https://jterrace.github.io/sphinxtr/ Projects integrating Sphinx functionality ----------------------------------------- -* *Read the Docs*, a software-as-a-service documentation hosting platform, uses - Sphinx to automatically build documentation updates that are pushed to GitHub: - https://readthedocs.org/ +* `Read the Docs`__, a software-as-a-service documentation hosting platform, uses + Sphinx to automatically build documentation updates that are pushed to GitHub -* *Spyder*, the Scientific Python Development Environment, uses Sphinx in its +* `Spyder`__, the Scientific Python Development Environment, uses Sphinx in its help pane to render rich documentation for functions, classes and methods - automatically or on-demand: https://docs.spyder-ide.org/help.html + automatically or on-demand + + __ https://readthedocs.org/ + __ https://docs.spyder-ide.org/help.html From 572f081d22a9c8a360947001def7fe65197f483d Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Thu, 9 Aug 2018 13:34:56 +0200 Subject: [PATCH 109/174] #5278 fix some markup glitches --- EXAMPLES | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/EXAMPLES b/EXAMPLES index e20c967cb..ca7e698b2 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -145,7 +145,6 @@ __ https://cmake.org/documentation/ __ http://docs.enthought.com/chaco/ __ http://cormoran.nhopkg.org/docs/ __ https://deap.readthedocs.io/ -__ https://deap.readthedocs.io/ __ https://pythonhosted.org/director/ __ https://pageperso.lif.univ-mrs.fr/~edouard.thiel/ez-draw/doc/en/html/ez-manual.html __ http://f2py.sourceforge.net/docs/ @@ -643,7 +642,7 @@ Homepages and other non-documentation sites * `Benoit Boissinot`__ (classic, customized) * `Computer Networks, Parallelization, and Simulation Laboratory (CNPSLab)`__ (sphinx_rtd_theme) * `Deep Learning Tutorials`__ (sphinxdoc) -* `Loyola University Chicago COMP 339-439 Distributed Systems course´__ (sphinx_bootstrap_theme) +* `Loyola University Chicago COMP 339-439 Distributed Systems course`__ (sphinx_bootstrap_theme) * `Pylearn2`__ (sphinxdoc, customized) * `SciPy Cookbook`__ (sphinx_rtd_theme) * `The Wine Cellar Book`__ (sphinxdoc) @@ -670,11 +669,11 @@ Books produced using Sphinx * `"The Hitchhiker's Guide to Python"`__ * `"LassoGuide"`__ * `"Learning Sphinx" (in Japanese)`__ -* `"Mercurial`__ the definitive guide (Second edition)"`__ +* `"Mercurial__ the definitive guide (Second edition)"`__ * `"Pioneers and Prominent Men of Utah"`__ * `"Pomodoro Technique Illustrated" (Japanese translation)`__ * `"Python Professional Programming" (in Japanese)`__ -* `"The ``repoze.bfg`` Web Application Framework"`__ +* `"The repoze.bfg Web Application Framework"`__ * `"Simple and Steady Way of Learning for Software Engineering" (in Japanese)`__ * `"Software-Dokumentation mit Sphinx"`__ * `"Theoretical Physics Reference"`__ From 60be8a268427025483457b8e5a36d1c39b934f8c Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Thu, 9 Aug 2018 14:50:58 +0200 Subject: [PATCH 110/174] #5278 remove duplicate & fix markup glitch --- EXAMPLES | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/EXAMPLES b/EXAMPLES index ca7e698b2..5b7bf83b1 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -293,7 +293,6 @@ Documentation using sphinx_rtd_theme * `Certbot`__ * `Chainer`__ (customized) * `CherryPy`__ -* `Chainer`__ * `CodeIgniter`__ * `Conda`__ * `Corda`__ @@ -392,7 +391,6 @@ __ https://bootstrap-datepicker.readthedocs.io/ __ https://letsencrypt.readthedocs.io/ __ https://docs.chainer.org/ __ http://docs.cherrypy.org/ -__ https://docs.chainer.org/ __ https://www.codeigniter.com/user_guide/ __ https://conda.io/docs/ __ https://docs.corda.net/ @@ -669,7 +667,7 @@ Books produced using Sphinx * `"The Hitchhiker's Guide to Python"`__ * `"LassoGuide"`__ * `"Learning Sphinx" (in Japanese)`__ -* `"Mercurial__ the definitive guide (Second edition)"`__ +* `"Mercurial: the definitive guide (Second edition)"`__ * `"Pioneers and Prominent Men of Utah"`__ * `"Pomodoro Technique Illustrated" (Japanese translation)`__ * `"Python Professional Programming" (in Japanese)`__ From 3cdb1724f9469bd881c2671af603b32dda303837 Mon Sep 17 00:00:00 2001 From: cclauss Date: Fri, 10 Aug 2018 18:50:02 +0200 Subject: [PATCH 111/174] Appveyor: Test in Python 3.7 instead of Python 3.6 --- .appveyor.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.appveyor.yml b/.appveyor.yml index 9a4028780..a0c948246 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -7,8 +7,8 @@ environment: matrix: - PYTHON: 27 TEST_IGNORE: --ignore py35 - - PYTHON: 36 - - PYTHON: 36-x64 + - PYTHON: 37 + - PYTHON: 37-x64 install: - C:\Python%PYTHON%\python.exe -m pip install -U pip setuptools From 742c89f99b0cbcf4e6a54a1b59ad3e424531463d Mon Sep 17 00:00:00 2001 From: Terence Honles Date: Thu, 9 Aug 2018 12:31:16 -0700 Subject: [PATCH 112/174] change format_args to prefer annotations from typing.get_type_hints The current code looks for the pattern:: class Node: def parent(self) -> 'Node': pass This change allows more complex forward references:: class Node: def children(self) -> Set['Node']: pass --- sphinx/util/inspect.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 615b6c976..c472a1b96 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -433,8 +433,7 @@ class Signature(object): if PY2 or self.return_annotation is inspect.Parameter.empty: return '(%s)' % ', '.join(args) else: - if isinstance(self.return_annotation, string_types) and \ - 'return' in self.annotations: + if 'return' in self.annotations: annotation = self.format_annotation(self.annotations['return']) else: annotation = self.format_annotation(self.return_annotation) From da45604485477d50e84ccd825f7348e0f560ead5 Mon Sep 17 00:00:00 2001 From: "Terence D. Honles" Date: Thu, 9 Aug 2018 14:47:35 -0700 Subject: [PATCH 113/174] handle NoneType as None --- sphinx/util/inspect.py | 6 ++++++ tests/test_util_inspect.py | 6 +++++- tests/typing_test_data.py | 5 +++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index c472a1b96..7dbf742b4 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -20,6 +20,7 @@ from six import PY2, PY3, StringIO, binary_type, string_types, itervalues from six.moves import builtins from sphinx.util import force_decode +from sphinx.util.pycompat import NoneType if False: # For type annotation @@ -464,6 +465,8 @@ class Signature(object): return annotation.__name__ elif not annotation: return repr(annotation) + elif annotation is NoneType: # type: ignore + return 'None' elif module == 'builtins': return annotation.__qualname__ elif annotation is Ellipsis: @@ -518,6 +521,9 @@ class Signature(object): else: qualified_name = (annotation.__module__ + '.' + annotation.__qualname__) # type: ignore # NOQA + if annotation is NoneType: # type: ignore + return 'None' + if annotation.__module__ == 'builtins': return annotation.__qualname__ # type: ignore elif (hasattr(typing, 'TupleMeta') and diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 9558f7277..2b6e0abb2 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -231,7 +231,8 @@ def test_Signature_partialmethod(): @pytest.mark.skipif(sys.version_info < (3, 5), reason='type annotation test is available on py35 or above') def test_Signature_annotations(): - from typing_test_data import f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12 + from typing_test_data import ( + f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, Node) # Class annotations sig = inspect.Signature(f0).format_args() @@ -288,6 +289,9 @@ def test_Signature_annotations(): sig = inspect.Signature(f12).format_args() assert sig == '() -> Tuple[int, str, int]' + sig = inspect.Signature(Node.children).format_args() + assert sig == '(self) -> List[typing_test_data.Node]' + def test_safe_getattr_with_default(): class Foo(object): diff --git a/tests/typing_test_data.py b/tests/typing_test_data.py index 71acf1f47..7ad90551d 100644 --- a/tests/typing_test_data.py +++ b/tests/typing_test_data.py @@ -66,3 +66,8 @@ def f11(x: CustomAnnotation(), y: 123) -> None: def f12() -> Tuple[int, str, int]: pass + + +class Node: + def children(self) -> List['Node']: + pass From 44127fd13b5d431852e3be145b937f113b00f73d Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Fri, 10 Aug 2018 22:13:18 +0200 Subject: [PATCH 114/174] C++, add support for (most) character literals. Fixes sphinx-doc/sphinx#5147 --- CHANGES | 1 + sphinx/domains/cpp.py | 65 ++++++++++++++++++++++++++++++++++++++-- tests/test_domain_cpp.py | 15 +++++++++- 3 files changed, 78 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 665438a54..4c4eedf24 100644 --- a/CHANGES +++ b/CHANGES @@ -167,6 +167,7 @@ Features added * C++, add support for unions. * C++, add support for anonymous entities using names staring with ``@``. Fixes #3593 and #2683. +* #5147: C++, add support for (most) character literals. * #3606: MathJax should be loaded with async attribute * html: Output ``canonical_url`` metadata if :confval:`html_baseurl` set (refs: #4193) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 7b2d3517e..adfc04c53 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -289,13 +289,26 @@ logger = logging.getLogger(__name__) nested-name """ -# TODO: support hex, oct, etc. work _integer_literal_re = re.compile(r'[1-9][0-9]*') _octal_literal_re = re.compile(r'0[0-7]*') _hex_literal_re = re.compile(r'0[xX][0-7a-fA-F][0-7a-fA-F]*') _binary_literal_re = re.compile(r'0[bB][01][01]*') _integer_suffix_re = re.compile(r'') _float_literal_re = re.compile(r'[+-]?[0-9]*\.[0-9]+') +_char_literal_re = re.compile(r'''(?x) + ((?:u8)|u|U|L)? + '( + (?:[^\\']) + | (\\( + (?:['"?\\abfnrtv]) + | (?:[0-7]{1,3}) + | (?:x[0-9a-fA-F]{2}) + | (?:u[0-9a-fA-F]{4}) + | (?:U[0-9a-fA-F]{8}) + )) + )' +''') + _anon_identifier_re = re.compile(r'(@[a-zA-Z0-9_])[a-zA-Z0-9_]*\b') _identifier_re = re.compile(r'''(?x) ( # This 'extends' _anon_identifier_re with the ordinary identifiers, @@ -522,6 +535,10 @@ _id_operator_unary_v2 = { '!': 'nt', '~': 'co' } +_id_char_from_prefix = { + None: 'c', 'u8': 'c', + 'u': 'Ds', 'U': 'Di', 'L': 'w' +} # type: Dict[unicode, unicode] # these are ordered by preceedence _expression_bin_ops = [ ['||'], @@ -780,6 +797,38 @@ class ASTNumberLiteral(ASTBase): signode.append(nodes.Text(txt, txt)) +class UnsupportedMultiCharacterCharLiteral(UnicodeMixin, Exception): + def __init__(self, decoded): + self.decoded = decoded + + +class ASTCharLiteral(ASTBase): + def __init__(self, prefix, data): + # type: (unicode, unicode) -> None + self.prefix = prefix # may be None when no prefix + self.data = data + assert prefix in _id_char_from_prefix + self.type = _id_char_from_prefix[prefix] + decoded = data.encode().decode('unicode-escape') + if len(decoded) == 1: + self.value = ord(decoded) + else: + raise UnsupportedMultiCharacterCharLiteral(decoded) + + def _stringify(self, transform): + if self.prefix is None: + return "'" + self.data + "'" + else: + return self.prefix + "'" + self.data + "'" + + def get_id(self, version): + return self.type + str(self.value) + + def describe_signature(self, signode, mode, env, symbol): + txt = text_type(self) + signode.append(nodes.Text(txt, txt)) + + class ASTStringLiteral(ASTBase): def __init__(self, data): # type: (unicode) -> None @@ -4177,7 +4226,19 @@ class DefinitionParser(object): string = self._parse_string() if string is not None: return ASTStringLiteral(string) - # TODO: char lit + + # character-literal + if self.match(_char_literal_re): + prefix = self.last_match.group(1) # may be None when no prefix + data = self.last_match.group(2) + try: + return ASTCharLiteral(prefix, data) + except UnicodeDecodeError as e: + self.fail("Can not handle character literal. Internal error was: %s" % e) + except UnsupportedMultiCharacterCharLiteral as e: + self.fail("Can not handle character literal" + " resulting in multiple decoded characters.") + # TODO: user-defined lit return None diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index e13381817..06856cebc 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -127,7 +127,20 @@ def test_expressions(): exprCheck(expr, 'L' + expr + 'E') exprCheck('"abc\\"cba"', 'LA8_KcE') # string exprCheck('this', 'fpT') - # TODO: test the rest + # character literals + for p, t in [('', 'c'), ('u8', 'c'), ('u', 'Ds'), ('U', 'Di'), ('L', 'w')]: + exprCheck(p + "'a'", t + "97") + exprCheck(p + "'\\n'", t + "10") + exprCheck(p + "'\\012'", t + "10") + exprCheck(p + "'\\0'", t + "0") + exprCheck(p + "'\\x0a'", t + "10") + exprCheck(p + "'\\x0A'", t + "10") + exprCheck(p + "'\\u0a42'", t + "2626") + exprCheck(p + "'\\u0A42'", t + "2626") + exprCheck(p + "'\\U0001f34c'", t + "127820") + exprCheck(p + "'\\U0001F34C'", t + "127820") + + # TODO: user-defined lit exprCheck('(... + Ns)', '(... + Ns)') exprCheck('(5)', 'L5E') exprCheck('C', '1C') From 4e79cca59f33c96c2f1a4a4f33a97733a6bdefce Mon Sep 17 00:00:00 2001 From: cclauss Date: Sat, 11 Aug 2018 06:02:06 +0200 Subject: [PATCH 115/174] Force a retest as a workaround to Travis issues --- .appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.appveyor.yml b/.appveyor.yml index a0c948246..56d7dd7ac 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -7,7 +7,7 @@ environment: matrix: - PYTHON: 27 TEST_IGNORE: --ignore py35 - - PYTHON: 37 + - PYTHON: 37 - PYTHON: 37-x64 install: From 72beacb7aeb854cfcc657dd5f3c5ba0f08868483 Mon Sep 17 00:00:00 2001 From: cclauss Date: Sat, 11 Aug 2018 06:19:08 +0200 Subject: [PATCH 116/174] Remove trailing whitespace --- .appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.appveyor.yml b/.appveyor.yml index 56d7dd7ac..a0c948246 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -7,7 +7,7 @@ environment: matrix: - PYTHON: 27 TEST_IGNORE: --ignore py35 - - PYTHON: 37 + - PYTHON: 37 - PYTHON: 37-x64 install: From 0af74a76dcc3410d226980bda077ded3652e8a7d Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Fri, 10 Aug 2018 22:52:36 +0200 Subject: [PATCH 117/174] C++, add missing isPack for some template params Fixes sphinx-doc/sphinx#5126 --- CHANGES | 1 + sphinx/domains/cpp.py | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/CHANGES b/CHANGES index adae37a27..911e3889d 100644 --- a/CHANGES +++ b/CHANGES @@ -207,6 +207,7 @@ Bugs fixed * epub: spine has been broken when "self" is listed on toctree (refs: #4611) * #344: autosummary does not understand docstring of module level attributes * #5191: C++, prevent nested declarations in functions to avoid lookup problems. +* #5126: C++, add missing isPack method for certain template parameter types. * #5002: graphviz: SVGs do not adapt to the column width Testing diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index adfc04c53..3155b9326 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1492,6 +1492,10 @@ class ASTTemplateParamConstrainedTypeWithInit(ASTBase): # type: () -> ASTNestedName return self.type.name + @property + def isPack(self): + return self.type.isPack + def get_id(self, version, objectType=None, symbol=None): # type: (int, unicode, Symbol) -> unicode # this is not part of the normal name mangling in C++ @@ -1531,6 +1535,10 @@ class ASTTemplateParamTemplateType(ASTBase): id = self.get_identifier() return ASTNestedName([ASTNestedNameElement(id, None)], [False], rooted=False) + @property + def isPack(self): + return self.data.parameterPack + def get_identifier(self): # type: () -> unicode return self.data.get_identifier() @@ -1567,6 +1575,10 @@ class ASTTemplateParamNonType(ASTBase): id = self.get_identifier() return ASTNestedName([ASTNestedNameElement(id, None)], [False], rooted=False) + @property + def isPack(self): + return self.param.isPack + def get_identifier(self): # type: () -> unicode name = self.param.name @@ -2635,6 +2647,10 @@ class ASTDeclaratorRef(ASTBase): # type: () -> ASTNestedName return self.next.name + @property + def isPack(self): + return True + @property def function_params(self): # type: () -> Any @@ -2916,6 +2932,10 @@ class ASTDeclaratorNameParamQual(ASTBase): # type: () -> ASTNestedName return self.declId + @property + def isPack(self): + return False + @property def function_params(self): # type: () -> Any @@ -3014,6 +3034,10 @@ class ASTType(ASTBase): # type: () -> ASTNestedName return self.decl.name + @property + def isPack(self): + return self.decl.isPack + @property def function_params(self): # type: () -> Any @@ -3105,6 +3129,10 @@ class ASTTypeWithInit(ASTBase): # type: () -> ASTNestedName return self.type.name + @property + def isPack(self): + return self.type.isPack + def get_id(self, version, objectType=None, symbol=None): # type: (int, unicode, Symbol) -> unicode if objectType != 'member': From 4397606d03516cfa692b6a262ba5f41225b7a0f6 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Sat, 11 Aug 2018 10:30:10 +0200 Subject: [PATCH 118/174] C++, fix direct lookup problem Also clarify documentation regarding cross-references involving templates. See also sphinx-doc/sphinx#2057 --- CHANGES | 2 ++ doc/usage/restructuredtext/domains.rst | 28 +++++++++------- sphinx/domains/cpp.py | 45 +++++++++++++++++--------- 3 files changed, 48 insertions(+), 27 deletions(-) diff --git a/CHANGES b/CHANGES index 911e3889d..c693ef190 100644 --- a/CHANGES +++ b/CHANGES @@ -172,6 +172,8 @@ Features added * C++, add support for anonymous entities using names staring with ``@``. Fixes #3593 and #2683. * #5147: C++, add support for (most) character literals. +* C++, cross-referencing entities inside primary templates is supported, + and now properly documented. * #3606: MathJax should be loaded with async attribute * html: Output ``canonical_url`` metadata if :confval:`html_baseurl` set (refs: #4193) diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst index 95d31f6ce..afc8e8d39 100644 --- a/doc/usage/restructuredtext/domains.rst +++ b/doc/usage/restructuredtext/domains.rst @@ -1033,19 +1033,25 @@ Assume the following declarations. Inner In general the reference must include the template parameter declarations, -e.g., ``template\ Wrapper::Outer`` -(:cpp:class:`template\ Wrapper::Outer`). Currently the lookup -only succeed if the template parameter identifiers are equal strings. That is, -``template\ Wrapper::Outer`` will not work. +and template arguments for the prefix of qualified names. For example: -The inner class template cannot be directly referenced, unless the current -namespace is changed or the following shorthand is used. If a template -parameter list is omitted, then the lookup will assume either a template or a -non-template, but not a partial template specialisation. This means the -following references work. +- ``template\ Wrapper::Outer`` + (:cpp:class:`template\ Wrapper::Outer`) +- ``template\ template\ Wrapper::Outer::Inner`` + (:cpp:class:`template\ template\ Wrapper::Outer::Inner`) -- ``Wrapper::Outer`` (:cpp:class:`Wrapper::Outer`) -- ``Wrapper::Outer::Inner`` (:cpp:class:`Wrapper::Outer::Inner`) +Currently the lookup only succeed if the template parameter identifiers are equal strings. +That is, ``template\ Wrapper::Outer`` will not work. + +As a shorthand notation, if a template parameter list is omitted, +then the lookup will assume either a primary template or a non-template, +but not a partial template specialisation. +This means the following references work as well: + +- ``Wrapper::Outer`` + (:cpp:class:`Wrapper::Outer`) +- ``Wrapper::Outer::Inner`` + (:cpp:class:`Wrapper::Outer::Inner`) - ``template\ Wrapper::Outer::Inner`` (:cpp:class:`template\ Wrapper::Outer::Inner`) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 3155b9326..2db416376 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -3634,8 +3634,9 @@ class Symbol(object): return ASTNestedName(names, templates, rooted=False) def _find_named_symbol(self, identOrOp, templateParams, templateArgs, - templateShorthand, matchSelf, recurseInAnon): - # type: (Any, Any, Any, Any, bool, bool) -> Symbol + templateShorthand, matchSelf, recurseInAnon, + correctPrimaryTemplateArgs): + # type: (Any, Any, Any, Any, bool, bool, bool) -> Symbol def isSpecialization(): # the names of the template parameters must be given exactly as args @@ -3658,12 +3659,13 @@ class Symbol(object): if paramName != argName: return True return False - if templateParams is not None and templateArgs is not None: - # If both are given, but it's not a specialization, then do lookup as if - # there is no argument list. - # For example: template int A::var; - if not isSpecialization(): - templateArgs = None + if correctPrimaryTemplateArgs: + if templateParams is not None and templateArgs is not None: + # If both are given, but it's not a specialization, then do lookup as if + # there is no argument list. + # For example: template int A::var; + if not isSpecialization(): + templateArgs = None def matches(s): if s.identOrOp != identOrOp: @@ -3722,7 +3724,8 @@ class Symbol(object): templateArgs, templateShorthand=False, matchSelf=False, - recurseInAnon=True) + recurseInAnon=True, + correctPrimaryTemplateArgs=True) if symbol is None: symbol = Symbol(parent=parentSymbol, identOrOp=identOrOp, templateParams=templateParams, @@ -3746,7 +3749,8 @@ class Symbol(object): templateArgs, templateShorthand=False, matchSelf=False, - recurseInAnon=True) + recurseInAnon=True, + correctPrimaryTemplateArgs=False) if symbol: if not declaration: # good, just a scope creation @@ -3797,7 +3801,8 @@ class Symbol(object): templateArgs=otherChild.templateArgs, templateShorthand=False, matchSelf=False, - recurseInAnon=False) + recurseInAnon=False, + correctPrimaryTemplateArgs=False) if ourChild is None: # TODO: hmm, should we prune by docnames? self._children.append(otherChild) @@ -3860,7 +3865,8 @@ class Symbol(object): templateParams, templateArgs, templateShorthand=False, matchSelf=False, - recurseInAnon=False) + recurseInAnon=False, + correctPrimaryTemplateArgs=False) if not s: return None return s @@ -3911,7 +3917,8 @@ class Symbol(object): templateParams, templateArgs, templateShorthand=templateShorthand, matchSelf=matchSelf, - recurseInAnon=recurseInAnon) + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=False) if symbol is not None: return symbol # try without template params and args @@ -3919,7 +3926,8 @@ class Symbol(object): None, None, templateShorthand=templateShorthand, matchSelf=matchSelf, - recurseInAnon=recurseInAnon) + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=False) return symbol else: identOrOp = name.identOrOp @@ -3933,9 +3941,13 @@ class Symbol(object): templateParams, templateArgs, templateShorthand=templateShorthand, matchSelf=matchSelf, - recurseInAnon=recurseInAnon) + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=True) if symbol is None: - # TODO: maybe search without template args + # TODO: Maybe search without template args? + # Though, the correctPrimaryTemplateArgs above does + # that for primary templates. + # Is there another case where it would be good? return None # We have now matched part of a nested name, and need to match more # so even if we should matchSelf before, we definitely shouldn't @@ -6343,6 +6355,7 @@ class CPPDomain(Domain): if not parentSymbol: print("Target: ", target) print("ParentKey: ", parentKey) + print(rootSymbol.dump(1)) assert parentSymbol # should be there else: parentSymbol = rootSymbol From 349890266c9a6fa8d56de345caa90eb23bf42c2e Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Sat, 11 Aug 2018 16:39:27 +0200 Subject: [PATCH 119/174] C++, parse attributes on declerators as well. Fixes sphinx-doc/sphinx#5187 --- CHANGES | 1 + sphinx/domains/cpp.py | 47 +++++++++++++++++++++++++++++++++------- tests/test_domain_cpp.py | 6 +++++ 3 files changed, 46 insertions(+), 8 deletions(-) diff --git a/CHANGES b/CHANGES index c693ef190..784901fc8 100644 --- a/CHANGES +++ b/CHANGES @@ -210,6 +210,7 @@ Bugs fixed * #344: autosummary does not understand docstring of module level attributes * #5191: C++, prevent nested declarations in functions to avoid lookup problems. * #5126: C++, add missing isPack method for certain template parameter types. +* #5187: C++, parse attributes on declerators as well. * #5002: graphviz: SVGs do not adapt to the column width Testing diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 2db416376..3df19774d 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -2539,12 +2539,13 @@ class ASTArray(ASTBase): class ASTDeclaratorPtr(ASTBase): - def __init__(self, next, volatile, const): - # type: (Any, bool, bool) -> None + def __init__(self, next, volatile, const, attrs): + # type: (Any, bool, bool, Any) -> None assert next self.next = next self.volatile = volatile self.const = const + self.attrs = attrs @property def name(self): @@ -2563,13 +2564,17 @@ class ASTDeclaratorPtr(ASTBase): def _stringify(self, transform): res = ['*'] # type: List[unicode] + for a in self.attrs: + res.append(transform(a)) + if len(self.attrs) > 0 and (self.volatile or self.const): + res.append(' ') if self.volatile: res.append('volatile') if self.const: if self.volatile: res.append(' ') res.append('const') - if self.const or self.volatile: + if self.const or self.volatile or len(self.attrs) > 0: if self.next.require_space_after_declSpecs: res.append(' ') res.append(transform(self.next)) @@ -2621,6 +2626,10 @@ class ASTDeclaratorPtr(ASTBase): # type: (addnodes.desc_signature, unicode, BuildEnvironment, Symbol) -> None _verify_description_mode(mode) signode += nodes.Text("*") + for a in self.attrs: + a.describe_signature(signode) + if len(self.attrs) > 0 and (self.volatile or self.const): + signode += nodes.Text(' ') def _add_anno(signode, text): signode += addnodes.desc_annotation(text, text) @@ -2630,17 +2639,18 @@ class ASTDeclaratorPtr(ASTBase): if self.volatile: signode += nodes.Text(' ') _add_anno(signode, 'const') - if self.const or self.volatile: + if self.const or self.volatile or len(self.attrs) > 0: if self.next.require_space_after_declSpecs: signode += nodes.Text(' ') self.next.describe_signature(signode, mode, env, symbol) class ASTDeclaratorRef(ASTBase): - def __init__(self, next): + def __init__(self, next, attrs): # type: (Any) -> None assert next self.next = next + self.attrs = attrs @property def name(self): @@ -2661,7 +2671,13 @@ class ASTDeclaratorRef(ASTBase): return self.next.require_space_after_declSpecs() def _stringify(self, transform): - return '&' + transform(self.next) + res = ['&'] + for a in self.attrs: + res.append(transform(a)) + if len(self.attrs) > 0 and self.next.require_space_after_declSpecs: + res.append(' ') + res.append(transform(self.next)) + return u''.join(res) def get_modifiers_id(self, version): # type: (int) -> unicode @@ -2692,6 +2708,10 @@ class ASTDeclaratorRef(ASTBase): # type: (addnodes.desc_signature, unicode, BuildEnvironment, Symbol) -> None _verify_description_mode(mode) signode += nodes.Text("&") + for a in self.attrs: + a.describe_signature(signode) + if len(self.attrs) > 0 and self.next.require_space_after_declSpecs: + signode += nodes.Text(' ') self.next.describe_signature(signode, mode, env, symbol) @@ -5151,6 +5171,7 @@ class DefinitionParser(object): self.skip_ws() volatile = False const = False + attrs = [] while 1: if not volatile: volatile = self.skip_word_and_ws('volatile') @@ -5160,13 +5181,23 @@ class DefinitionParser(object): const = self.skip_word_and_ws('const') if const: continue + attr = self._parse_attribute() + if attr is not None: + attrs.append(attr) + continue break next = self._parse_declarator(named, paramMode, typed) - return ASTDeclaratorPtr(next=next, volatile=volatile, const=const) + return ASTDeclaratorPtr(next=next, volatile=volatile, const=const, attrs=attrs) # TODO: shouldn't we parse an R-value ref here first? if typed and self.skip_string("&"): + attrs = [] + while 1: + attr = self._parse_attribute() + if attr is None: + break + attrs.append(attr) next = self._parse_declarator(named, paramMode, typed) - return ASTDeclaratorRef(next=next) + return ASTDeclaratorRef(next=next, attrs=attrs) if typed and self.skip_string("..."): next = self._parse_declarator(named, paramMode, False) return ASTDeclaratorParamPack(next=next) diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 06856cebc..89c37aa3c 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -665,6 +665,12 @@ def test_attributes(): check('function', 'static inline __attribute__(()) void f()', {1: 'f', 2: '1fv'}, output='__attribute__(()) static inline void f()') + # position: declarator + check('member', 'int *[[attr]] i', {1: 'i__iP', 2:'1i'}) + check('member', 'int *const [[attr]] volatile i', {1: 'i__iPVC', 2: '1i'}, + output='int *[[attr]] volatile const i') + check('member', 'int &[[attr]] i', {1: 'i__iR', 2: '1i'}) + check('member', 'int *[[attr]] *i', {1: 'i__iPP', 2: '1i'}) # def test_print(): From 61a53b1cebf805201e714666e832d0470ab375ee Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Sat, 11 Aug 2018 17:28:15 +0200 Subject: [PATCH 120/174] Fix type check error --- sphinx/domains/cpp.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 3df19774d..598386c7b 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -2647,7 +2647,7 @@ class ASTDeclaratorPtr(ASTBase): class ASTDeclaratorRef(ASTBase): def __init__(self, next, attrs): - # type: (Any) -> None + # type: (Any, Any) -> None assert next self.next = next self.attrs = attrs From 2552efea253cf94cae43941a1e3e3e857b17a591 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 5 Aug 2018 13:18:30 +0900 Subject: [PATCH 121/174] Fix #4911: Allow make latexpdf on Windows --- sphinx/cmd/make_mode.py | 18 +++++++++--- sphinx/texinputs/make.bat_t | 55 +++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 4 deletions(-) create mode 100644 sphinx/texinputs/make.bat_t diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py index 2a368e11a..cf8673623 100644 --- a/sphinx/cmd/make_mode.py +++ b/sphinx/cmd/make_mode.py @@ -99,22 +99,32 @@ class Make(object): # type: () -> int if self.run_generic_build('latex') > 0: return 1 + + if sys.platform == 'win32': + makecmd = os.environ.get('MAKE', 'make.bat') + else: + makecmd = self.makecmd try: with cd(self.builddir_join('latex')): - return subprocess.call([self.makecmd, 'all-pdf']) + return subprocess.call([makecmd, 'all-pdf']) except OSError: - print('Error: Failed to run: %s' % self.makecmd) + print('Error: Failed to run: %s' % makecmd) return 1 def build_latexpdfja(self): # type: () -> int if self.run_generic_build('latex') > 0: return 1 + + if sys.platform == 'win32': + makecmd = os.environ.get('MAKE', 'make.bat') + else: + makecmd = self.makecmd try: with cd(self.builddir_join('latex')): - return subprocess.call([self.makecmd, 'all-pdf-ja']) + return subprocess.call([makecmd, 'all-pdf']) except OSError: - print('Error: Failed to run: %s' % self.makecmd) + print('Error: Failed to run: %s' % makecmd) return 1 def build_info(self): diff --git a/sphinx/texinputs/make.bat_t b/sphinx/texinputs/make.bat_t new file mode 100644 index 000000000..8d83fab5b --- /dev/null +++ b/sphinx/texinputs/make.bat_t @@ -0,0 +1,55 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +pushd %~dp0 + +{% if latex_engine == 'platex' -%} +REM latexmkrc is read then overridden by latexmkjarc +set PDFLATEX=latexmk -r latexmkjarc -pdfdvi -dvi- -ps- +{% else -%} +set PDFLATEX=latexmk -pdf -dvi- -ps- +{% endif %} +set LATEXOPTS= + +{% if xindy_use -%} +set XINDYOPTS={{ xindy_lang_option }} -M sphinx.xdy +{% if latex_engine == 'pdflatex' -%} +set XINDYOPTS=%XINDYOPTS% -M LICRlatin2utf8.xdy +{% if xindy_cyrillic -%} +set XINDYOPTS=%XINDYOPTS% -M LICRcyr2utf8.xdy +{% endif -%} +{% endif -%} +{% if xindy_cyrillic -%} +set XINDYOPTS=%XINDYOPTS% -M LatinRules.xdy +{% endif -%} +set XINDYOPTS=%XINDYOPTS% -I xelatex +{% endif -%} + + +if "%1" == "" goto all-pdf + +if "%1" == "all-pdf" ( + :all-pdf +{%- if latex_engine == 'platex' %} + for %%i in (*.png *.gif *.jpg *.jpeg *.pdf) do ( + extractbb %%i + ) +{%- endif %} + for %%i in (*.tex) do ( + %PDFLATEX% %LATEXMKOPTS% %%i + ) + goto end +) + +if "%1" == "all-pdf-ja" ( + goto all-pdf +) + +if "%1" == "clean" ( + del /q /s *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz *.fls *.fdb_latexmk + goto end +) + +:end +popd From 9fc753cf64c950f996eb6d5cd26b864315d19b61 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 13 Aug 2018 10:38:18 +0900 Subject: [PATCH 122/174] latex: Set empty string to $LATEXOPTS --- sphinx/texinputs/make.bat_t | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/texinputs/make.bat_t b/sphinx/texinputs/make.bat_t index 8d83fab5b..83dd449c2 100644 --- a/sphinx/texinputs/make.bat_t +++ b/sphinx/texinputs/make.bat_t @@ -10,7 +10,7 @@ set PDFLATEX=latexmk -r latexmkjarc -pdfdvi -dvi- -ps- {% else -%} set PDFLATEX=latexmk -pdf -dvi- -ps- {% endif %} -set LATEXOPTS= +set "LATEXOPTS= " {% if xindy_use -%} set XINDYOPTS={{ xindy_lang_option }} -M sphinx.xdy From f670a33f5bfe94974d9697017a6c91e119d2d942 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 4 Aug 2018 19:05:21 +0900 Subject: [PATCH 123/174] Fix #5246: Add :confval:`singlehtml_sidebars` to configure sidebars for singlehtml --- CHANGES | 2 ++ doc/usage/configuration.rst | 10 ++++++++++ sphinx/builders/html.py | 5 ++++- 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 784901fc8..ca6e9d5be 100644 --- a/CHANGES +++ b/CHANGES @@ -194,6 +194,8 @@ Features added * #4614: sphinx-build: Add ``--keep-going`` option to show all warnings * Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`) * quickstart: epub builder is enabled by default +* #5246: Add :confval:`singlehtml_sidebars` to configure sidebars for singlehtml + builder Bugs fixed ---------- diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index ba37ccdc1..208cd24a2 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1333,6 +1333,16 @@ that use Sphinx's HTMLWriter class. .. versionadded:: 1.6 +Options for Single HTML output +------------------------------- + +.. confval:: singlehtml_sidebars + + Custom sidebar templates, must be a dictionary that maps document names to + template names. And it only allows a key named `'index'`. All other keys + are ignored. For more information, refer to :confval:`html_sidebars`. By + default, it is same as :confval:`html_sidebars`. + .. _htmlhelp-options: diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index 0deaec707..a0550728e 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -1066,7 +1066,8 @@ class StandaloneHTMLBuilder(Builder): sidebars = [name.strip() for name in theme_default_sidebars.split(',')] # user sidebar settings - for pattern, patsidebars in iteritems(self.config.html_sidebars): + html_sidebars = self.get_builder_config('sidebars', 'html') + for pattern, patsidebars in iteritems(html_sidebars): if patmatch(pagename, pattern): if matched: if has_wildcard(pattern): @@ -1714,6 +1715,8 @@ def setup(app): app.add_config_value('html_baseurl', '', 'html') app.add_config_value('html_math_renderer', None, 'env') + app.add_config_value('singlehtml_sidebars', lambda self: self.html_sidebars, 'html') + # event handlers app.connect('config-inited', convert_html_css_files) app.connect('config-inited', convert_html_js_files) From 07ba03650bdf6b4bfa814869951cf5e6b5f92b6b Mon Sep 17 00:00:00 2001 From: MAEDA Go Date: Mon, 13 Aug 2018 14:48:01 +0900 Subject: [PATCH 124/174] Add "Redmine Primer" to EXAMPLES --- EXAMPLES | 2 ++ 1 file changed, 2 insertions(+) diff --git a/EXAMPLES b/EXAMPLES index 5b7bf83b1..34e063dc6 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -671,6 +671,7 @@ Books produced using Sphinx * `"Pioneers and Prominent Men of Utah"`__ * `"Pomodoro Technique Illustrated" (Japanese translation)`__ * `"Python Professional Programming" (in Japanese)`__ +* `"Redmine Primer 5th Edition (in Japanese)"`__ * `"The repoze.bfg Web Application Framework"`__ * `"Simple and Steady Way of Learning for Software Engineering" (in Japanese)`__ * `"Software-Dokumentation mit Sphinx"`__ @@ -687,6 +688,7 @@ __ https://book.mercurial-scm.org/ __ http://pioneers.rstebbing.com/ __ https://www.amazon.co.jp/dp/4048689525/ __ http://www.amazon.co.jp/dp/4798032948/ +__ https://www.shuwasystem.co.jp/products/7980html/4825.html __ https://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379 __ https://www.amazon.co.jp/dp/477414259X/ __ https://www.amazon.de/dp/1497448689/ From ba97fd4f8d0f6c82ba44f2298093a040bde28c51 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 5 Aug 2018 00:15:45 +0900 Subject: [PATCH 125/174] latex: Invoke mendex from perl (for Windows) --- sphinx/texinputs/latexmkjarc | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/sphinx/texinputs/latexmkjarc b/sphinx/texinputs/latexmkjarc index 39ea47f3b..93c7fc78c 100644 --- a/sphinx/texinputs/latexmkjarc +++ b/sphinx/texinputs/latexmkjarc @@ -1,6 +1,23 @@ $latex = 'platex ' . $ENV{'LATEXOPTS'} . ' -kanji=utf8 %O %S'; $dvipdf = 'dvipdfmx %O -o %D %S'; -$makeindex = 'rm -f %D; mendex -U -f -d %B.dic -s python.ist %S || echo "mendex exited with error code $? (ignoring)" && : >> %D'; +$makeindex = 'internal mendex %S %B %D'; +sub mendex { + my ($source, $basename, $destination) = @_; + my $dictfile = $basename . ".dic"; + unlink($destination); + if (-f $dictfile) { + system("mendex", "-U", "-f", "-d", $dictfile, "-s", "python.ist", $source); + if ($? > 0) { + print("mendex exited with error code $? (ignored)\n"); + } + } + if (!-e $destination) { + # create an empty .ind file if nothing + open(FH, ">" . $destination); + close(FH); + } + return 0; +} add_cus_dep( "glo", "gls", 0, "makeglo" ); sub makeglo { return system( "mendex -J -f -s gglo.ist -o '$_[0].gls' '$_[0].glo'" ); From caf57bcc89869edba0b81b174d4957087390299c Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 13 Aug 2018 21:41:17 +0900 Subject: [PATCH 126/174] Update CHANGES for PR #5280 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index 26d016677..4881ce3c4 100644 --- a/CHANGES +++ b/CHANGES @@ -26,6 +26,7 @@ Bugs fixed 1.5 * LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern font with XeLaTeX/LuaLateX (refs: #5251) +* #5280: autodoc: Fix wrong type annotations for complex typing Testing -------- From 1878a52837bc6ff4883483067bf75cf254b72208 Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Mon, 13 Aug 2018 23:18:42 +0200 Subject: [PATCH 127/174] Update karma dependency for JS tests --- package-lock.json | 2584 +++++++++------------------------------------ package.json | 2 +- 2 files changed, 508 insertions(+), 2078 deletions(-) diff --git a/package-lock.json b/package-lock.json index cc76843a2..a94df69ad 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,109 +9,24 @@ "integrity": "sha1-63d99gEXI6OxTopywIBcjoZ0a9I=", "dev": true, "requires": { - "mime-types": "2.1.19", + "mime-types": "~2.1.18", "negotiator": "0.6.1" } }, - "addressparser": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/addressparser/-/addressparser-1.0.1.tgz", - "integrity": "sha1-R6++GiqSYhkdtoOOT9HTm0CCF0Y=", - "dev": true, - "optional": true - }, "after": { "version": "0.8.2", "resolved": "https://registry.npmjs.org/after/-/after-0.8.2.tgz", "integrity": "sha1-/ts5T58OAqqXaOcCvaI7UF+ufh8=", "dev": true }, - "agent-base": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-4.2.1.tgz", - "integrity": "sha512-JVwXMr9nHYTUXsBFKUqhJwvlcYU/blreOEUkhNR2eXZIvwd+c+o5V4MgDPKWnMS/56awN3TRzIP+KoPn+roQtg==", - "dev": true, - "requires": { - "es6-promisify": "5.0.0" - } - }, - "ajv": { - "version": "5.5.2", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-5.5.2.tgz", - "integrity": "sha1-c7Xuyj+rZT49P5Qis0GtQiBdyWU=", - "dev": true, - "optional": true, - "requires": { - "co": "4.6.0", - "fast-deep-equal": "1.1.0", - "fast-json-stable-stringify": "2.0.0", - "json-schema-traverse": "0.3.1" - } - }, - "amqplib": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/amqplib/-/amqplib-0.5.2.tgz", - "integrity": "sha512-l9mCs6LbydtHqRniRwYkKdqxVa6XMz3Vw1fh+2gJaaVgTM6Jk3o8RccAKWKtlhT1US5sWrFh+KKxsVUALURSIA==", - "dev": true, - "optional": true, - "requires": { - "bitsyntax": "0.0.4", - "bluebird": "3.5.1", - "buffer-more-ints": "0.0.2", - "readable-stream": "1.1.14", - "safe-buffer": "5.1.2" - }, - "dependencies": { - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true, - "optional": true - }, - "readable-stream": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", - "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", - "dev": true, - "optional": true, - "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "0.0.1", - "string_decoder": "0.10.31" - } - }, - "string_decoder": { - "version": "0.10.31", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", - "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", - "dev": true, - "optional": true - } - } - }, - "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true - }, - "ansi-styles": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", - "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4=", - "dev": true, - "optional": true - }, "anymatch": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-2.0.0.tgz", "integrity": "sha512-5teOsQWABXHHBFP9y3skS5P3d/WfWXpv3FUpy+LorMrNYaT9pI4oLMQX7jzQ2KklNpGpWHzdCXTDT2Y3XGlZBw==", "dev": true, "requires": { - "micromatch": "3.1.10", - "normalize-path": "2.1.1" + "micromatch": "^3.1.4", + "normalize-path": "^2.1.1" } }, "arr-diff": { @@ -150,42 +65,12 @@ "integrity": "sha512-wGUIVQXuehL5TCqQun8OW81jGzAWycqzFF8lFp+GOM5BXLYj3bKNsYC4daB7n6XjCqxQA/qgTJ+8ANR3acjrog==", "dev": true }, - "asn1": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.3.tgz", - "integrity": "sha1-2sh4dxPJlmhJ/IGAd36+nB3fO4Y=", - "dev": true, - "optional": true - }, - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - }, "assign-symbols": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-1.0.0.tgz", "integrity": "sha1-WWZ/QfrdTyDMvCu5a41Pf3jsA2c=", "dev": true }, - "ast-types": { - "version": "0.11.5", - "resolved": "https://registry.npmjs.org/ast-types/-/ast-types-0.11.5.tgz", - "integrity": "sha512-oJjo+5e7/vEc2FBK8gUalV0pba4L3VdBIs2EKhOLHLcOd2FgQIVQN9xb0eZ9IjEWyAL7vq6fGJxOvVvdCHNyMw==", - "dev": true, - "optional": true - }, - "async": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/async/-/async-2.6.1.tgz", - "integrity": "sha512-fNEiL2+AZt6AlAw/29Cr0UDe4sRAHCpEHh54WMz+Bb7QfNcFw4h3loofyJpLeQs4Yx7yuqu/2dLgM5hKOs6HlQ==", - "dev": true, - "optional": true, - "requires": { - "lodash": "4.17.10" - } - }, "async-each": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/async-each/-/async-each-1.0.1.tgz", @@ -198,55 +83,12 @@ "integrity": "sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg==", "dev": true }, - "asynckit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", - "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=", - "dev": true, - "optional": true - }, "atob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/atob/-/atob-2.1.1.tgz", "integrity": "sha1-ri1acpR38onWDdf5amMUoi3Wwio=", "dev": true }, - "aws-sign2": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", - "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=", - "dev": true, - "optional": true - }, - "aws4": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.7.0.tgz", - "integrity": "sha512-32NDda82rhwD9/JBCCkB+MRYDp0oSvlo2IL6rQWA10PQi7tDUM3eqMSltXmY+Oyl/7N3P3qNtAlv7X0d9bI28w==", - "dev": true, - "optional": true - }, - "axios": { - "version": "0.15.3", - "resolved": "https://registry.npmjs.org/axios/-/axios-0.15.3.tgz", - "integrity": "sha1-LJ1jiy4ZGgjqHWzJiOrda6W9wFM=", - "dev": true, - "optional": true, - "requires": { - "follow-redirects": "1.0.0" - }, - "dependencies": { - "follow-redirects": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.0.0.tgz", - "integrity": "sha1-jjQpjL0uF28lTv/sdaHHjMhJ/Tc=", - "dev": true, - "optional": true, - "requires": { - "debug": "2.6.9" - } - } - } - }, "backo2": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/backo2/-/backo2-1.0.2.tgz", @@ -265,13 +107,13 @@ "integrity": "sha512-5T6P4xPgpp0YDFvSWwEZ4NoE3aM4QBQXDzmVbraCkFj8zHM+mba8SyqB5DbZWyR7mYHo6Y7BdQo3MoA4m0TeQg==", "dev": true, "requires": { - "cache-base": "1.0.1", - "class-utils": "0.3.6", - "component-emitter": "1.2.1", - "define-property": "1.0.0", - "isobject": "3.0.1", - "mixin-deep": "1.3.1", - "pascalcase": "0.1.1" + "cache-base": "^1.0.1", + "class-utils": "^0.3.5", + "component-emitter": "^1.2.1", + "define-property": "^1.0.0", + "isobject": "^3.0.1", + "mixin-deep": "^1.2.0", + "pascalcase": "^0.1.1" }, "dependencies": { "define-property": { @@ -280,7 +122,7 @@ "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", "dev": true, "requires": { - "is-descriptor": "1.0.2" + "is-descriptor": "^1.0.0" } }, "is-accessor-descriptor": { @@ -289,7 +131,7 @@ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-data-descriptor": { @@ -298,7 +140,7 @@ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-descriptor": { @@ -307,9 +149,9 @@ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", "dev": true, "requires": { - "is-accessor-descriptor": "1.0.0", - "is-data-descriptor": "1.0.0", - "kind-of": "6.0.2" + "is-accessor-descriptor": "^1.0.0", + "is-data-descriptor": "^1.0.0", + "kind-of": "^6.0.2" } } } @@ -326,16 +168,6 @@ "integrity": "sha1-R2iMuZu2gE8OBtPnY7HDLlfY5rY=", "dev": true }, - "bcrypt-pbkdf": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", - "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=", - "dev": true, - "optional": true, - "requires": { - "tweetnacl": "0.14.5" - } - }, "better-assert": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/better-assert/-/better-assert-1.0.2.tgz", @@ -351,57 +183,6 @@ "integrity": "sha1-RqoXUftqL5PuXmibsQh9SxTGwgU=", "dev": true }, - "bitsyntax": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/bitsyntax/-/bitsyntax-0.0.4.tgz", - "integrity": "sha1-6xDMb4K4xJDj6FaY8H6D1G4MuoI=", - "dev": true, - "optional": true, - "requires": { - "buffer-more-ints": "0.0.2" - } - }, - "bl": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/bl/-/bl-1.1.2.tgz", - "integrity": "sha1-/cqHGplxOqANGeO7ukHER4emU5g=", - "dev": true, - "optional": true, - "requires": { - "readable-stream": "2.0.6" - }, - "dependencies": { - "process-nextick-args": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-1.0.7.tgz", - "integrity": "sha1-FQ4gt1ZZCtP5EJPyWk8q2L/zC6M=", - "dev": true, - "optional": true - }, - "readable-stream": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.0.6.tgz", - "integrity": "sha1-j5A0HmilPMySh4jaz80Rs265t44=", - "dev": true, - "optional": true, - "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "1.0.0", - "process-nextick-args": "1.0.7", - "string_decoder": "0.10.31", - "util-deprecate": "1.0.2" - } - }, - "string_decoder": { - "version": "0.10.31", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", - "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", - "dev": true, - "optional": true - } - } - }, "blob": { "version": "0.0.4", "resolved": "https://registry.npmjs.org/blob/-/blob-0.0.4.tgz", @@ -421,24 +202,15 @@ "dev": true, "requires": { "bytes": "3.0.0", - "content-type": "1.0.4", + "content-type": "~1.0.4", "debug": "2.6.9", - "depd": "1.1.2", - "http-errors": "1.6.3", + "depd": "~1.1.2", + "http-errors": "~1.6.3", "iconv-lite": "0.4.23", - "on-finished": "2.3.0", + "on-finished": "~2.3.0", "qs": "6.5.2", "raw-body": "2.3.3", - "type-is": "1.6.16" - } - }, - "boom": { - "version": "2.10.1", - "resolved": "https://registry.npmjs.org/boom/-/boom-2.10.1.tgz", - "integrity": "sha1-OciRjO/1eZ+D+UkqhI9iWt0Mdm8=", - "dev": true, - "requires": { - "hoek": "2.16.3" + "type-is": "~1.6.16" } }, "brace-expansion": { @@ -447,7 +219,7 @@ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, "requires": { - "balanced-match": "1.0.0", + "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, @@ -457,16 +229,16 @@ "integrity": "sha512-aNdbnj9P8PjdXU4ybaWLK2IF3jc/EoDYbC7AazW6to3TRsfXxscC9UXOB5iDiEQrkyIbWp2SLQda4+QAa7nc3w==", "dev": true, "requires": { - "arr-flatten": "1.1.0", - "array-unique": "0.3.2", - "extend-shallow": "2.0.1", - "fill-range": "4.0.0", - "isobject": "3.0.1", - "repeat-element": "1.1.2", - "snapdragon": "0.8.2", - "snapdragon-node": "2.1.1", - "split-string": "3.1.0", - "to-regex": "3.0.2" + "arr-flatten": "^1.1.0", + "array-unique": "^0.3.2", + "extend-shallow": "^2.0.1", + "fill-range": "^4.0.0", + "isobject": "^3.0.1", + "repeat-element": "^1.1.2", + "snapdragon": "^0.8.1", + "snapdragon-node": "^2.0.1", + "split-string": "^3.0.2", + "to-regex": "^3.0.1" }, "dependencies": { "extend-shallow": { @@ -475,32 +247,32 @@ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, "requires": { - "is-extendable": "0.1.1" + "is-extendable": "^0.1.0" } } } }, - "buffer-more-ints": { - "version": "0.0.2", - "resolved": "https://registry.npmjs.org/buffer-more-ints/-/buffer-more-ints-0.0.2.tgz", - "integrity": "sha1-JrOIXRD6E9t/wBquOquHAZngEkw=", + "buffer-alloc": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/buffer-alloc/-/buffer-alloc-1.2.0.tgz", + "integrity": "sha512-CFsHQgjtW1UChdXgbyJGtnm+O/uLQeZdtbDo8mfUgYXCHSM1wgrVxXm6bSyrUuErEb+4sYVGCzASBRot7zyrow==", + "dev": true, + "requires": { + "buffer-alloc-unsafe": "^1.1.0", + "buffer-fill": "^1.0.0" + } + }, + "buffer-alloc-unsafe": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/buffer-alloc-unsafe/-/buffer-alloc-unsafe-1.1.0.tgz", + "integrity": "sha512-TEM2iMIEQdJ2yjPJoSIsldnleVaAk1oW3DBVUykyOLsEsFmEc9kn+SFFPz+gl54KQNxlDnAwCXosOS9Okx2xAg==", "dev": true }, - "buildmail": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/buildmail/-/buildmail-4.0.1.tgz", - "integrity": "sha1-h393OLeHKYccmhBeO4N9K+EaenI=", - "dev": true, - "optional": true, - "requires": { - "addressparser": "1.0.1", - "libbase64": "0.1.0", - "libmime": "3.0.0", - "libqp": "1.1.0", - "nodemailer-fetch": "1.6.0", - "nodemailer-shared": "1.1.0", - "punycode": "1.4.1" - } + "buffer-fill": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/buffer-fill/-/buffer-fill-1.0.0.tgz", + "integrity": "sha1-+PeLdniYiO858gXNY39o5wISKyw=", + "dev": true }, "bytes": { "version": "3.0.0", @@ -514,15 +286,15 @@ "integrity": "sha512-AKcdTnFSWATd5/GCPRxr2ChwIJ85CeyrEyjRHlKxQ56d4XJMGym0uAiKn0xbLOGOl3+yRpOTi484dVCEc5AUzQ==", "dev": true, "requires": { - "collection-visit": "1.0.0", - "component-emitter": "1.2.1", - "get-value": "2.0.6", - "has-value": "1.0.0", - "isobject": "3.0.1", - "set-value": "2.0.0", - "to-object-path": "0.3.0", - "union-value": "1.0.0", - "unset-value": "1.0.0" + "collection-visit": "^1.0.0", + "component-emitter": "^1.2.1", + "get-value": "^2.0.6", + "has-value": "^1.0.0", + "isobject": "^3.0.1", + "set-value": "^2.0.0", + "to-object-path": "^0.3.0", + "union-value": "^1.0.0", + "unset-value": "^1.0.0" } }, "callsite": { @@ -531,46 +303,25 @@ "integrity": "sha1-KAOY5dZkvXQDi28JBRU+borxvCA=", "dev": true }, - "caseless": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", - "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=", - "dev": true, - "optional": true - }, - "chalk": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz", - "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=", - "dev": true, - "optional": true, - "requires": { - "ansi-styles": "2.2.1", - "escape-string-regexp": "1.0.5", - "has-ansi": "2.0.0", - "strip-ansi": "3.0.1", - "supports-color": "2.0.0" - } - }, "chokidar": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-2.0.4.tgz", "integrity": "sha512-z9n7yt9rOvIJrMhvDtDictKrkFHeihkNl6uWMmZlmL6tJtX9Cs+87oK+teBx+JIgzvbX3yZHT3eF8vpbDxHJXQ==", "dev": true, "requires": { - "anymatch": "2.0.0", - "async-each": "1.0.1", - "braces": "2.3.2", - "fsevents": "1.2.4", - "glob-parent": "3.1.0", - "inherits": "2.0.3", - "is-binary-path": "1.0.1", - "is-glob": "4.0.0", - "lodash.debounce": "4.0.8", - "normalize-path": "2.1.1", - "path-is-absolute": "1.0.1", - "readdirp": "2.1.0", - "upath": "1.1.0" + "anymatch": "^2.0.0", + "async-each": "^1.0.0", + "braces": "^2.3.0", + "fsevents": "^1.2.2", + "glob-parent": "^3.1.0", + "inherits": "^2.0.1", + "is-binary-path": "^1.0.0", + "is-glob": "^4.0.0", + "lodash.debounce": "^4.0.8", + "normalize-path": "^2.1.1", + "path-is-absolute": "^1.0.0", + "readdirp": "^2.0.0", + "upath": "^1.0.5" } }, "circular-json": { @@ -585,10 +336,10 @@ "integrity": "sha512-qOhPa/Fj7s6TY8H8esGu5QNpMMQxz79h+urzrNYN6mn+9BnxlDGf5QZ+XeCDsxSjPqsSR56XOZOJmpeurnLMeg==", "dev": true, "requires": { - "arr-union": "3.1.0", - "define-property": "0.2.5", - "isobject": "3.0.1", - "static-extend": "0.1.2" + "arr-union": "^3.1.0", + "define-property": "^0.2.5", + "isobject": "^3.0.0", + "static-extend": "^0.1.1" }, "dependencies": { "define-property": { @@ -597,32 +348,25 @@ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, "requires": { - "is-descriptor": "0.1.6" + "is-descriptor": "^0.1.0" } } } }, - "co": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", - "integrity": "sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=", - "dev": true, - "optional": true - }, "collection-visit": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz", "integrity": "sha1-S8A3PBZLwykbTTaMgpzxqApZ3KA=", "dev": true, "requires": { - "map-visit": "1.0.0", - "object-visit": "1.0.1" + "map-visit": "^1.0.0", + "object-visit": "^1.0.0" } }, "colors": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.3.0.tgz", - "integrity": "sha512-EDpX3a7wHMWFA7PUHWPHNWqOxIIRSJetuwl0AS5Oi/5FMV8kWm69RTlgm00GKjBO1xFHMtBbL49yRtMMdticBw==", + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.3.1.tgz", + "integrity": "sha512-jg/vxRmv430jixZrC+La5kMbUWqIg32/JsYNZb94+JEmzceYbWKTsv1OuTp+7EaqiaWRR2tPcykibwCRgclIsw==", "dev": true }, "combine-lists": { @@ -631,25 +375,9 @@ "integrity": "sha1-RYwH4J4NkA/Ci3Cj/sLazR0st/Y=", "dev": true, "requires": { - "lodash": "4.17.10" + "lodash": "^4.5.0" } }, - "combined-stream": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.6.tgz", - "integrity": "sha1-cj599ugBrFYTETp+RFqbactjKBg=", - "dev": true, - "requires": { - "delayed-stream": "1.0.0" - } - }, - "commander": { - "version": "2.16.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.16.0.tgz", - "integrity": "sha512-sVXqklSaotK9at437sFlFpyOcJonxe0yST/AG9DkQKUdIE6IqGIMv4SfAQSKaJbSdVEJYItASCrBiVQHq1HQew==", - "dev": true, - "optional": true - }, "component-bind": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/component-bind/-/component-bind-1.0.0.tgz", @@ -682,7 +410,7 @@ "requires": { "debug": "2.6.9", "finalhandler": "1.1.0", - "parseurl": "1.3.2", + "parseurl": "~1.3.2", "utils-merge": "1.0.1" } }, @@ -716,39 +444,12 @@ "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", "dev": true }, - "cryptiles": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/cryptiles/-/cryptiles-2.0.5.tgz", - "integrity": "sha1-O9/s3GCBR8HGcgL6KR59ylnqo7g=", - "dev": true, - "optional": true, - "requires": { - "boom": "2.10.1" - } - }, "custom-event": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/custom-event/-/custom-event-1.0.1.tgz", "integrity": "sha1-XQKkaFCt8bSjF5RqOSj8y1v9BCU=", "dev": true }, - "dashdash": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", - "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", - "dev": true, - "optional": true, - "requires": { - "assert-plus": "1.0.0" - } - }, - "data-uri-to-buffer": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-1.2.0.tgz", - "integrity": "sha512-vKQ9DTQPN1FLYiiEEOQ6IBGFqvjCa5rSK3cWMy/Nespm5d/x3dGFT9UBZnkLxCwua/IXBi2TYnwTEpsOvhC4UQ==", - "dev": true, - "optional": true - }, "date-format": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/date-format/-/date-format-1.2.0.tgz", @@ -770,21 +471,14 @@ "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=", "dev": true }, - "deep-is": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz", - "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", - "dev": true, - "optional": true - }, "define-property": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/define-property/-/define-property-2.0.2.tgz", "integrity": "sha512-jwK2UV4cnPpbcG7+VRARKTZPUWowwXA8bzH5NP6ud0oeAxyYPuGZUAC7hMugpCdz4BeSZl2Dl9k66CHJ/46ZYQ==", "dev": true, "requires": { - "is-descriptor": "1.0.2", - "isobject": "3.0.1" + "is-descriptor": "^1.0.2", + "isobject": "^3.0.1" }, "dependencies": { "is-accessor-descriptor": { @@ -793,7 +487,7 @@ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-data-descriptor": { @@ -802,7 +496,7 @@ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-descriptor": { @@ -811,31 +505,13 @@ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", "dev": true, "requires": { - "is-accessor-descriptor": "1.0.0", - "is-data-descriptor": "1.0.0", - "kind-of": "6.0.2" + "is-accessor-descriptor": "^1.0.0", + "is-data-descriptor": "^1.0.0", + "kind-of": "^6.0.2" } } } }, - "degenerator": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/degenerator/-/degenerator-1.0.4.tgz", - "integrity": "sha1-/PSQo37OJmRk2cxDGrmMWBnO0JU=", - "dev": true, - "optional": true, - "requires": { - "ast-types": "0.11.5", - "escodegen": "1.11.0", - "esprima": "3.1.3" - } - }, - "delayed-stream": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", - "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", - "dev": true - }, "depd": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", @@ -854,27 +530,10 @@ "integrity": "sha1-ViromZ9Evl6jB29UGdzVnrQ6yVs=", "dev": true, "requires": { - "custom-event": "1.0.1", - "ent": "2.2.0", - "extend": "3.0.2", - "void-elements": "2.0.1" - } - }, - "double-ended-queue": { - "version": "2.1.0-0", - "resolved": "https://registry.npmjs.org/double-ended-queue/-/double-ended-queue-2.1.0-0.tgz", - "integrity": "sha1-ED01J/0xUo9AGIEwyEHv3XgmTlw=", - "dev": true, - "optional": true - }, - "ecc-jsbn": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.1.tgz", - "integrity": "sha1-D8c6ntXw1Tw4GTOYUj735UN3dQU=", - "dev": true, - "optional": true, - "requires": { - "jsbn": "0.1.1" + "custom-event": "~1.0.0", + "ent": "~2.2.0", + "extend": "^3.0.0", + "void-elements": "^2.0.0" } }, "ee-first": { @@ -890,18 +549,17 @@ "dev": true }, "engine.io": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-3.1.5.tgz", - "integrity": "sha512-D06ivJkYxyRrcEe0bTpNnBQNgP9d3xog+qZlLbui8EsMr/DouQpf5o9FzJnWYHEYE0YsFHllUv2R1dkgYZXHcA==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-3.2.0.tgz", + "integrity": "sha512-mRbgmAtQ4GAlKwuPnnAvXXwdPhEx+jkc0OBCLrXuD/CRvwNK3AxRSnqK4FSqmAMRRHryVJP8TopOvmEaA64fKw==", "dev": true, "requires": { - "accepts": "1.3.5", + "accepts": "~1.3.4", "base64id": "1.0.0", "cookie": "0.3.1", - "debug": "3.1.0", - "engine.io-parser": "2.1.2", - "uws": "9.14.0", - "ws": "3.3.3" + "debug": "~3.1.0", + "engine.io-parser": "~2.1.0", + "ws": "~3.3.1" }, "dependencies": { "debug": { @@ -916,21 +574,21 @@ } }, "engine.io-client": { - "version": "3.1.6", - "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-3.1.6.tgz", - "integrity": "sha512-hnuHsFluXnsKOndS4Hv6SvUrgdYx1pk2NqfaDMW+GWdgfU3+/V25Cj7I8a0x92idSpa5PIhJRKxPvp9mnoLsfg==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-3.2.1.tgz", + "integrity": "sha512-y5AbkytWeM4jQr7m/koQLc5AxpRKC1hEVUb/s1FUAWEJq5AzJJ4NLvzuKPuxtDi5Mq755WuDvZ6Iv2rXj4PTzw==", "dev": true, "requires": { "component-emitter": "1.2.1", "component-inherit": "0.0.3", - "debug": "3.1.0", - "engine.io-parser": "2.1.2", + "debug": "~3.1.0", + "engine.io-parser": "~2.1.1", "has-cors": "1.1.0", "indexof": "0.0.1", "parseqs": "0.0.5", "parseuri": "0.0.5", - "ws": "3.3.3", - "xmlhttprequest-ssl": "1.5.5", + "ws": "~3.3.1", + "xmlhttprequest-ssl": "~1.5.4", "yeast": "0.1.2" }, "dependencies": { @@ -952,10 +610,10 @@ "dev": true, "requires": { "after": "0.8.2", - "arraybuffer.slice": "0.0.7", + "arraybuffer.slice": "~0.0.7", "base64-arraybuffer": "0.1.5", "blob": "0.0.4", - "has-binary2": "1.0.3" + "has-binary2": "~1.0.2" } }, "ent": { @@ -964,68 +622,12 @@ "integrity": "sha1-6WQhkyWiHQX0RGai9obtbOX13R0=", "dev": true }, - "es6-promise": { - "version": "4.2.4", - "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.4.tgz", - "integrity": "sha512-/NdNZVJg+uZgtm9eS3O6lrOLYmQag2DjdEXuPaHlZ6RuVqgqaVZfgYCepEIKsLqwdQArOPtC3XzRLqGGfT8KQQ==", - "dev": true - }, - "es6-promisify": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/es6-promisify/-/es6-promisify-5.0.0.tgz", - "integrity": "sha1-UQnWLz5W6pZ8S2NQWu8IKRyKUgM=", - "dev": true, - "requires": { - "es6-promise": "4.2.4" - } - }, "escape-html": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", "integrity": "sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=", "dev": true }, - "escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true, - "optional": true - }, - "escodegen": { - "version": "1.11.0", - "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.11.0.tgz", - "integrity": "sha512-IeMV45ReixHS53K/OmfKAIztN/igDHzTJUhZM3k1jMhIZWjk45SMwAtBsEXiJp3vSPmTcu6CXn7mDvFHRN66fw==", - "dev": true, - "optional": true, - "requires": { - "esprima": "3.1.3", - "estraverse": "4.2.0", - "esutils": "2.0.2", - "optionator": "0.8.2", - "source-map": "0.6.1" - } - }, - "esprima": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-3.1.3.tgz", - "integrity": "sha1-/cpRzuYTOJXjyI1TXOSdv/YqRjM=", - "dev": true - }, - "estraverse": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.2.0.tgz", - "integrity": "sha1-De4/7TH81GlhjOc0IJn8GvoL2xM=", - "dev": true, - "optional": true - }, - "esutils": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.2.tgz", - "integrity": "sha1-Cr9PHKpbyx96nYrMbepPqqBLrJs=", - "dev": true, - "optional": true - }, "eventemitter3": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-3.1.0.tgz", @@ -1038,9 +640,9 @@ "integrity": "sha1-SIsdHSRRyz06axks/AMPRMWFX+o=", "dev": true, "requires": { - "array-slice": "0.2.3", - "array-unique": "0.2.1", - "braces": "0.1.5" + "array-slice": "^0.2.3", + "array-unique": "^0.2.1", + "braces": "^0.1.2" }, "dependencies": { "array-unique": { @@ -1055,7 +657,7 @@ "integrity": "sha1-wIVxEIUpHYt1/ddOqw+FlygHEeY=", "dev": true, "requires": { - "expand-range": "0.1.1" + "expand-range": "^0.1.0" } } } @@ -1066,13 +668,13 @@ "integrity": "sha1-t3c14xXOMPa27/D4OwQVGiJEliI=", "dev": true, "requires": { - "debug": "2.6.9", - "define-property": "0.2.5", - "extend-shallow": "2.0.1", - "posix-character-classes": "0.1.1", - "regex-not": "1.0.2", - "snapdragon": "0.8.2", - "to-regex": "3.0.2" + "debug": "^2.3.3", + "define-property": "^0.2.5", + "extend-shallow": "^2.0.1", + "posix-character-classes": "^0.1.0", + "regex-not": "^1.0.0", + "snapdragon": "^0.8.1", + "to-regex": "^3.0.1" }, "dependencies": { "define-property": { @@ -1081,7 +683,7 @@ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, "requires": { - "is-descriptor": "0.1.6" + "is-descriptor": "^0.1.0" } }, "extend-shallow": { @@ -1090,7 +692,7 @@ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, "requires": { - "is-extendable": "0.1.1" + "is-extendable": "^0.1.0" } } } @@ -1101,8 +703,8 @@ "integrity": "sha1-TLjtoJk8pW+k9B/ELzy7TMrf8EQ=", "dev": true, "requires": { - "is-number": "0.1.1", - "repeat-string": "0.2.2" + "is-number": "^0.1.1", + "repeat-string": "^0.2.2" }, "dependencies": { "is-number": { @@ -1131,8 +733,8 @@ "integrity": "sha1-Jqcarwc7OfshJxcnRhMcJwQCjbg=", "dev": true, "requires": { - "assign-symbols": "1.0.0", - "is-extendable": "1.0.1" + "assign-symbols": "^1.0.0", + "is-extendable": "^1.0.1" }, "dependencies": { "is-extendable": { @@ -1141,7 +743,7 @@ "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", "dev": true, "requires": { - "is-plain-object": "2.0.4" + "is-plain-object": "^2.0.4" } } } @@ -1152,14 +754,14 @@ "integrity": "sha512-Nmb6QXkELsuBr24CJSkilo6UHHgbekK5UiZgfE6UHD3Eb27YC6oD+bhcT+tJ6cl8dmsgdQxnWlcry8ksBIBLpw==", "dev": true, "requires": { - "array-unique": "0.3.2", - "define-property": "1.0.0", - "expand-brackets": "2.1.4", - "extend-shallow": "2.0.1", - "fragment-cache": "0.2.1", - "regex-not": "1.0.2", - "snapdragon": "0.8.2", - "to-regex": "3.0.2" + "array-unique": "^0.3.2", + "define-property": "^1.0.0", + "expand-brackets": "^2.1.4", + "extend-shallow": "^2.0.1", + "fragment-cache": "^0.2.1", + "regex-not": "^1.0.0", + "snapdragon": "^0.8.1", + "to-regex": "^3.0.1" }, "dependencies": { "define-property": { @@ -1168,7 +770,7 @@ "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", "dev": true, "requires": { - "is-descriptor": "1.0.2" + "is-descriptor": "^1.0.0" } }, "extend-shallow": { @@ -1177,7 +779,7 @@ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, "requires": { - "is-extendable": "0.1.1" + "is-extendable": "^0.1.0" } }, "is-accessor-descriptor": { @@ -1186,7 +788,7 @@ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-data-descriptor": { @@ -1195,7 +797,7 @@ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-descriptor": { @@ -1204,57 +806,23 @@ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", "dev": true, "requires": { - "is-accessor-descriptor": "1.0.0", - "is-data-descriptor": "1.0.0", - "kind-of": "6.0.2" + "is-accessor-descriptor": "^1.0.0", + "is-data-descriptor": "^1.0.0", + "kind-of": "^6.0.2" } } } }, - "extsprintf": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", - "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=", - "dev": true - }, - "fast-deep-equal": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-1.1.0.tgz", - "integrity": "sha1-wFNHeBfIa1HaqFPIHgWbcz0CNhQ=", - "dev": true, - "optional": true - }, - "fast-json-stable-stringify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", - "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=", - "dev": true, - "optional": true - }, - "fast-levenshtein": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", - "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", - "dev": true, - "optional": true - }, - "file-uri-to-path": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", - "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", - "dev": true, - "optional": true - }, "fill-range": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-4.0.0.tgz", "integrity": "sha1-1USBHUKPmOsGpj3EAtJAPDKMOPc=", "dev": true, "requires": { - "extend-shallow": "2.0.1", - "is-number": "3.0.0", - "repeat-string": "1.6.1", - "to-regex-range": "2.1.1" + "extend-shallow": "^2.0.1", + "is-number": "^3.0.0", + "repeat-string": "^1.6.1", + "to-regex-range": "^2.1.0" }, "dependencies": { "extend-shallow": { @@ -1263,7 +831,7 @@ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, "requires": { - "is-extendable": "0.1.1" + "is-extendable": "^0.1.0" } } } @@ -1275,12 +843,12 @@ "dev": true, "requires": { "debug": "2.6.9", - "encodeurl": "1.0.2", - "escape-html": "1.0.3", - "on-finished": "2.3.0", - "parseurl": "1.3.2", - "statuses": "1.3.1", - "unpipe": "1.0.0" + "encodeurl": "~1.0.1", + "escape-html": "~1.0.3", + "on-finished": "~2.3.0", + "parseurl": "~1.3.2", + "statuses": "~1.3.1", + "unpipe": "~1.0.0" }, "dependencies": { "statuses": { @@ -1292,12 +860,12 @@ } }, "follow-redirects": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.1.tgz", - "integrity": "sha512-v9GI1hpaqq1ZZR6pBD1+kI7O24PhDvNGNodjS3MdcEqyrahCp8zbtpv+2B/krUnSmUH80lbAS7MrdeK5IylgKg==", + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.5.tgz", + "integrity": "sha512-GHjtHDlY/ehslqv0Gr5N0PUJppgg/q0rOBvX0na1s7y1A3LWxPqCYU76s3Z1bM4+UZB4QF0usaXLT5wFpof5PA==", "dev": true, "requires": { - "debug": "3.1.0" + "debug": "^3.1.0" }, "dependencies": { "debug": { @@ -1317,32 +885,13 @@ "integrity": "sha1-gQaNKVqBQuwKxybG4iAMMPttXoA=", "dev": true }, - "forever-agent": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", - "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=", - "dev": true, - "optional": true - }, - "form-data": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.2.tgz", - "integrity": "sha1-SXBJi+YEwgwAXU9cI67NIda0kJk=", - "dev": true, - "optional": true, - "requires": { - "asynckit": "0.4.0", - "combined-stream": "1.0.6", - "mime-types": "2.1.19" - } - }, "fragment-cache": { "version": "0.2.1", "resolved": "https://registry.npmjs.org/fragment-cache/-/fragment-cache-0.2.1.tgz", "integrity": "sha1-QpD60n8T6Jvn8zeZxrxaCr//DRk=", "dev": true, "requires": { - "map-cache": "0.2.2" + "map-cache": "^0.2.2" } }, "fs-access": { @@ -1351,7 +900,7 @@ "integrity": "sha1-1qh/JiJxzv6+wwxVNAf7mV2od3o=", "dev": true, "requires": { - "null-check": "1.0.0" + "null-check": "^1.0.0" } }, "fs.realpath": { @@ -1367,8 +916,8 @@ "dev": true, "optional": true, "requires": { - "nan": "2.10.0", - "node-pre-gyp": "0.10.0" + "nan": "^2.9.2", + "node-pre-gyp": "^0.10.0" }, "dependencies": { "abbrev": { @@ -1394,8 +943,8 @@ "dev": true, "optional": true, "requires": { - "delegates": "1.0.0", - "readable-stream": "2.3.6" + "delegates": "^1.0.0", + "readable-stream": "^2.0.6" } }, "balanced-match": { @@ -1408,7 +957,7 @@ "bundled": true, "dev": true, "requires": { - "balanced-match": "1.0.0", + "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, @@ -1472,7 +1021,7 @@ "dev": true, "optional": true, "requires": { - "minipass": "2.2.4" + "minipass": "^2.2.1" } }, "fs.realpath": { @@ -1487,14 +1036,14 @@ "dev": true, "optional": true, "requires": { - "aproba": "1.2.0", - "console-control-strings": "1.1.0", - "has-unicode": "2.0.1", - "object-assign": "4.1.1", - "signal-exit": "3.0.2", - "string-width": "1.0.2", - "strip-ansi": "3.0.1", - "wide-align": "1.1.2" + "aproba": "^1.0.3", + "console-control-strings": "^1.0.0", + "has-unicode": "^2.0.0", + "object-assign": "^4.1.0", + "signal-exit": "^3.0.0", + "string-width": "^1.0.1", + "strip-ansi": "^3.0.1", + "wide-align": "^1.1.0" } }, "glob": { @@ -1503,12 +1052,12 @@ "dev": true, "optional": true, "requires": { - "fs.realpath": "1.0.0", - "inflight": "1.0.6", - "inherits": "2.0.3", - "minimatch": "3.0.4", - "once": "1.4.0", - "path-is-absolute": "1.0.1" + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" } }, "has-unicode": { @@ -1523,7 +1072,7 @@ "dev": true, "optional": true, "requires": { - "safer-buffer": "2.1.2" + "safer-buffer": "^2.1.0" } }, "ignore-walk": { @@ -1532,7 +1081,7 @@ "dev": true, "optional": true, "requires": { - "minimatch": "3.0.4" + "minimatch": "^3.0.4" } }, "inflight": { @@ -1541,8 +1090,8 @@ "dev": true, "optional": true, "requires": { - "once": "1.4.0", - "wrappy": "1.0.2" + "once": "^1.3.0", + "wrappy": "1" } }, "inherits": { @@ -1561,7 +1110,7 @@ "bundled": true, "dev": true, "requires": { - "number-is-nan": "1.0.1" + "number-is-nan": "^1.0.0" } }, "isarray": { @@ -1575,7 +1124,7 @@ "bundled": true, "dev": true, "requires": { - "brace-expansion": "1.1.11" + "brace-expansion": "^1.1.7" } }, "minimist": { @@ -1588,8 +1137,8 @@ "bundled": true, "dev": true, "requires": { - "safe-buffer": "5.1.1", - "yallist": "3.0.2" + "safe-buffer": "^5.1.1", + "yallist": "^3.0.0" } }, "minizlib": { @@ -1598,7 +1147,7 @@ "dev": true, "optional": true, "requires": { - "minipass": "2.2.4" + "minipass": "^2.2.1" } }, "mkdirp": { @@ -1621,9 +1170,9 @@ "dev": true, "optional": true, "requires": { - "debug": "2.6.9", - "iconv-lite": "0.4.21", - "sax": "1.2.4" + "debug": "^2.1.2", + "iconv-lite": "^0.4.4", + "sax": "^1.2.4" } }, "node-pre-gyp": { @@ -1632,16 +1181,16 @@ "dev": true, "optional": true, "requires": { - "detect-libc": "1.0.3", - "mkdirp": "0.5.1", - "needle": "2.2.0", - "nopt": "4.0.1", - "npm-packlist": "1.1.10", - "npmlog": "4.1.2", - "rc": "1.2.7", - "rimraf": "2.6.2", - "semver": "5.5.0", - "tar": "4.4.1" + "detect-libc": "^1.0.2", + "mkdirp": "^0.5.1", + "needle": "^2.2.0", + "nopt": "^4.0.1", + "npm-packlist": "^1.1.6", + "npmlog": "^4.0.2", + "rc": "^1.1.7", + "rimraf": "^2.6.1", + "semver": "^5.3.0", + "tar": "^4" } }, "nopt": { @@ -1650,8 +1199,8 @@ "dev": true, "optional": true, "requires": { - "abbrev": "1.1.1", - "osenv": "0.1.5" + "abbrev": "1", + "osenv": "^0.1.4" } }, "npm-bundled": { @@ -1666,8 +1215,8 @@ "dev": true, "optional": true, "requires": { - "ignore-walk": "3.0.1", - "npm-bundled": "1.0.3" + "ignore-walk": "^3.0.1", + "npm-bundled": "^1.0.1" } }, "npmlog": { @@ -1676,10 +1225,10 @@ "dev": true, "optional": true, "requires": { - "are-we-there-yet": "1.1.4", - "console-control-strings": "1.1.0", - "gauge": "2.7.4", - "set-blocking": "2.0.0" + "are-we-there-yet": "~1.1.2", + "console-control-strings": "~1.1.0", + "gauge": "~2.7.3", + "set-blocking": "~2.0.0" } }, "number-is-nan": { @@ -1698,7 +1247,7 @@ "bundled": true, "dev": true, "requires": { - "wrappy": "1.0.2" + "wrappy": "1" } }, "os-homedir": { @@ -1719,8 +1268,8 @@ "dev": true, "optional": true, "requires": { - "os-homedir": "1.0.2", - "os-tmpdir": "1.0.2" + "os-homedir": "^1.0.0", + "os-tmpdir": "^1.0.0" } }, "path-is-absolute": { @@ -1741,10 +1290,10 @@ "dev": true, "optional": true, "requires": { - "deep-extend": "0.5.1", - "ini": "1.3.5", - "minimist": "1.2.0", - "strip-json-comments": "2.0.1" + "deep-extend": "^0.5.1", + "ini": "~1.3.0", + "minimist": "^1.2.0", + "strip-json-comments": "~2.0.1" }, "dependencies": { "minimist": { @@ -1761,13 +1310,13 @@ "dev": true, "optional": true, "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "1.0.0", - "process-nextick-args": "2.0.0", - "safe-buffer": "5.1.1", - "string_decoder": "1.1.1", - "util-deprecate": "1.0.2" + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" } }, "rimraf": { @@ -1776,7 +1325,7 @@ "dev": true, "optional": true, "requires": { - "glob": "7.1.2" + "glob": "^7.0.5" } }, "safe-buffer": { @@ -1819,9 +1368,9 @@ "bundled": true, "dev": true, "requires": { - "code-point-at": "1.1.0", - "is-fullwidth-code-point": "1.0.0", - "strip-ansi": "3.0.1" + "code-point-at": "^1.0.0", + "is-fullwidth-code-point": "^1.0.0", + "strip-ansi": "^3.0.0" } }, "string_decoder": { @@ -1830,7 +1379,7 @@ "dev": true, "optional": true, "requires": { - "safe-buffer": "5.1.1" + "safe-buffer": "~5.1.0" } }, "strip-ansi": { @@ -1838,7 +1387,7 @@ "bundled": true, "dev": true, "requires": { - "ansi-regex": "2.1.1" + "ansi-regex": "^2.0.0" } }, "strip-json-comments": { @@ -1853,13 +1402,13 @@ "dev": true, "optional": true, "requires": { - "chownr": "1.0.1", - "fs-minipass": "1.2.5", - "minipass": "2.2.4", - "minizlib": "1.1.0", - "mkdirp": "0.5.1", - "safe-buffer": "5.1.1", - "yallist": "3.0.2" + "chownr": "^1.0.1", + "fs-minipass": "^1.2.5", + "minipass": "^2.2.4", + "minizlib": "^1.1.0", + "mkdirp": "^0.5.0", + "safe-buffer": "^5.1.1", + "yallist": "^3.0.2" } }, "util-deprecate": { @@ -1874,7 +1423,7 @@ "dev": true, "optional": true, "requires": { - "string-width": "1.0.2" + "string-width": "^1.0.2" } }, "wrappy": { @@ -1889,106 +1438,24 @@ } } }, - "ftp": { - "version": "0.3.10", - "resolved": "https://registry.npmjs.org/ftp/-/ftp-0.3.10.tgz", - "integrity": "sha1-kZfYYa2BQvPmPVqDv+TFn3MwiF0=", - "dev": true, - "optional": true, - "requires": { - "readable-stream": "1.1.14", - "xregexp": "2.0.0" - }, - "dependencies": { - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true, - "optional": true - }, - "readable-stream": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", - "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", - "dev": true, - "optional": true, - "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "0.0.1", - "string_decoder": "0.10.31" - } - }, - "string_decoder": { - "version": "0.10.31", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", - "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", - "dev": true, - "optional": true - } - } - }, - "generate-function": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz", - "integrity": "sha1-aFj+fAlpt9TpCTM3ZHrHn2DfvnQ=", - "dev": true, - "optional": true - }, - "generate-object-property": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/generate-object-property/-/generate-object-property-1.2.0.tgz", - "integrity": "sha1-nA4cQDCM6AT0eDYYuTf6iPmdUNA=", - "dev": true, - "optional": true, - "requires": { - "is-property": "1.0.2" - } - }, - "get-uri": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-2.0.2.tgz", - "integrity": "sha512-ZD325dMZOgerGqF/rF6vZXyFGTAay62svjQIT+X/oU2PtxYpFxvSkbsdi+oxIrsNxlZVd4y8wUDqkaExWTI/Cw==", - "dev": true, - "optional": true, - "requires": { - "data-uri-to-buffer": "1.2.0", - "debug": "2.6.9", - "extend": "3.0.2", - "file-uri-to-path": "1.0.0", - "ftp": "0.3.10", - "readable-stream": "2.3.6" - } - }, "get-value": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=", "dev": true }, - "getpass": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", - "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", - "dev": true, - "optional": true, - "requires": { - "assert-plus": "1.0.0" - } - }, "glob": { "version": "7.1.2", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz", "integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==", "dev": true, "requires": { - "fs.realpath": "1.0.0", - "inflight": "1.0.6", - "inherits": "2.0.3", - "minimatch": "3.0.4", - "once": "1.4.0", - "path-is-absolute": "1.0.1" + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" } }, "glob-parent": { @@ -1997,8 +1464,8 @@ "integrity": "sha1-nmr2KZ2NO9K9QEMIMr0RPfkGxa4=", "dev": true, "requires": { - "is-glob": "3.1.0", - "path-dirname": "1.0.2" + "is-glob": "^3.1.0", + "path-dirname": "^1.0.0" }, "dependencies": { "is-glob": { @@ -2007,7 +1474,7 @@ "integrity": "sha1-e6WuJCF4BKxwcHuWkiVnSGzD6Eo=", "dev": true, "requires": { - "is-extglob": "2.1.1" + "is-extglob": "^2.1.0" } } } @@ -2018,34 +1485,6 @@ "integrity": "sha1-Dovf5NHduIVNZOBOp8AOKgJuVlg=", "dev": true }, - "har-schema": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", - "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=", - "dev": true, - "optional": true - }, - "har-validator": { - "version": "5.0.3", - "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.0.3.tgz", - "integrity": "sha1-ukAsJmGU8VlW7xXg/PJCmT9qff0=", - "dev": true, - "optional": true, - "requires": { - "ajv": "5.5.2", - "har-schema": "2.0.0" - } - }, - "has-ansi": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/has-ansi/-/has-ansi-2.0.0.tgz", - "integrity": "sha1-NPUEnOHs3ysGSa8+8k5F7TVBbZE=", - "dev": true, - "optional": true, - "requires": { - "ansi-regex": "2.1.1" - } - }, "has-binary2": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has-binary2/-/has-binary2-1.0.3.tgz", @@ -2075,9 +1514,9 @@ "integrity": "sha1-GLKB2lhbHFxR3vJMkw7SmgvmsXc=", "dev": true, "requires": { - "get-value": "2.0.6", - "has-values": "1.0.0", - "isobject": "3.0.1" + "get-value": "^2.0.6", + "has-values": "^1.0.0", + "isobject": "^3.0.0" } }, "has-values": { @@ -2086,8 +1525,8 @@ "integrity": "sha1-lbC2P+whRmGab+V/51Yo1aOe/k8=", "dev": true, "requires": { - "is-number": "3.0.0", - "kind-of": "4.0.0" + "is-number": "^3.0.0", + "kind-of": "^4.0.0" }, "dependencies": { "kind-of": { @@ -2096,51 +1535,21 @@ "integrity": "sha1-IIE989cSkosgc3hpGkUGb65y3Vc=", "dev": true, "requires": { - "is-buffer": "1.1.6" + "is-buffer": "^1.1.5" } } } }, - "hawk": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/hawk/-/hawk-3.1.3.tgz", - "integrity": "sha1-B4REvXwWQLD+VA0sm3PVlnjo4cQ=", - "dev": true, - "optional": true, - "requires": { - "boom": "2.10.1", - "cryptiles": "2.0.5", - "hoek": "2.16.3", - "sntp": "1.0.9" - } - }, - "hipchat-notifier": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/hipchat-notifier/-/hipchat-notifier-1.1.0.tgz", - "integrity": "sha1-ttJJdVQ3wZEII2d5nTupoPI7Ix4=", - "dev": true, - "optional": true, - "requires": { - "lodash": "4.17.10", - "request": "2.87.0" - } - }, - "hoek": { - "version": "2.16.3", - "resolved": "https://registry.npmjs.org/hoek/-/hoek-2.16.3.tgz", - "integrity": "sha1-ILt0A9POo5jpHcRxCo/xuCdKJe0=", - "dev": true - }, "http-errors": { "version": "1.6.3", "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz", "integrity": "sha1-i1VoC7S+KDoLW/TqLjhYC+HZMg0=", "dev": true, "requires": { - "depd": "1.1.2", + "depd": "~1.1.2", "inherits": "2.0.3", "setprototypeof": "1.1.0", - "statuses": "1.5.0" + "statuses": ">= 1.4.0 < 2" } }, "http-proxy": { @@ -2149,79 +1558,9 @@ "integrity": "sha512-Taqn+3nNvYRfJ3bGvKfBSRwy1v6eePlm3oc/aWVxZp57DQr5Eq3xhKJi7Z4hZpS8PC3H4qI+Yly5EmFacGuA/g==", "dev": true, "requires": { - "eventemitter3": "3.1.0", - "follow-redirects": "1.5.1", - "requires-port": "1.0.0" - } - }, - "http-proxy-agent": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-2.1.0.tgz", - "integrity": "sha512-qwHbBLV7WviBl0rQsOzH6o5lwyOIvwp/BdFnvVxXORldu5TmjFfjzBcWUWS5kWAZhmv+JtiDhSuQCp4sBfbIgg==", - "dev": true, - "requires": { - "agent-base": "4.2.1", - "debug": "3.1.0" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - } - } - }, - "http-signature": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", - "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", - "dev": true, - "optional": true, - "requires": { - "assert-plus": "1.0.0", - "jsprim": "1.4.1", - "sshpk": "1.14.2" - } - }, - "httpntlm": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/httpntlm/-/httpntlm-1.6.1.tgz", - "integrity": "sha1-rQFScUOi6Hc8+uapb1hla7UqNLI=", - "dev": true, - "requires": { - "httpreq": "0.4.24", - "underscore": "1.7.0" - } - }, - "httpreq": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/httpreq/-/httpreq-0.4.24.tgz", - "integrity": "sha1-QzX/2CzZaWaKOUZckprGHWOTYn8=", - "dev": true - }, - "https-proxy-agent": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-2.2.1.tgz", - "integrity": "sha512-HPCTS1LW51bcyMYbxUIOO4HEOlQ1/1qRaFWcyxvwaqUS9TY88aoEuHUY33kuAh1YhVVaDQhLZsnPd+XNARWZlQ==", - "dev": true, - "requires": { - "agent-base": "4.2.1", - "debug": "3.1.0" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - } + "eventemitter3": "^3.0.0", + "follow-redirects": "^1.0.0", + "requires-port": "^1.0.0" } }, "iconv-lite": { @@ -2230,7 +1569,7 @@ "integrity": "sha512-neyTUVFtahjf0mB3dZT77u+8O0QB89jFdnBkd5P1JgYPbPaia3gXXOVL2fq8VyU2gMMD7SaN7QukTB/pmXYvDA==", "dev": true, "requires": { - "safer-buffer": "2.1.2" + "safer-buffer": ">= 2.1.2 < 3" } }, "indexof": { @@ -2239,21 +1578,14 @@ "integrity": "sha1-gtwzbSMrkGIXnQWrMpOmYFn9Q10=", "dev": true }, - "inflection": { - "version": "1.12.0", - "resolved": "https://registry.npmjs.org/inflection/-/inflection-1.12.0.tgz", - "integrity": "sha1-ogCTVlbW9fa8TcdQLhrstwMihBY=", - "dev": true, - "optional": true - }, "inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", "dev": true, "requires": { - "once": "1.4.0", - "wrappy": "1.0.2" + "once": "^1.3.0", + "wrappy": "1" } }, "inherits": { @@ -2262,19 +1594,13 @@ "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", "dev": true }, - "ip": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/ip/-/ip-1.1.5.tgz", - "integrity": "sha1-vd7XARQpCCjAoDnnLvJfWq7ENUo=", - "dev": true - }, "is-accessor-descriptor": { "version": "0.1.6", "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-0.1.6.tgz", "integrity": "sha1-qeEss66Nh2cn7u84Q/igiXtcmNY=", "dev": true, "requires": { - "kind-of": "3.2.2" + "kind-of": "^3.0.2" }, "dependencies": { "kind-of": { @@ -2283,7 +1609,7 @@ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", "dev": true, "requires": { - "is-buffer": "1.1.6" + "is-buffer": "^1.1.5" } } } @@ -2294,7 +1620,7 @@ "integrity": "sha1-dfFmQrSA8YenEcgUFh/TpKdlWJg=", "dev": true, "requires": { - "binary-extensions": "1.11.0" + "binary-extensions": "^1.0.0" } }, "is-buffer": { @@ -2309,7 +1635,7 @@ "integrity": "sha1-C17mSDiOLIYCgueT8YVv7D8wG1Y=", "dev": true, "requires": { - "kind-of": "3.2.2" + "kind-of": "^3.0.2" }, "dependencies": { "kind-of": { @@ -2318,7 +1644,7 @@ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", "dev": true, "requires": { - "is-buffer": "1.1.6" + "is-buffer": "^1.1.5" } } } @@ -2329,9 +1655,9 @@ "integrity": "sha512-avDYr0SB3DwO9zsMov0gKCESFYqCnE4hq/4z3TdUlukEy5t9C0YRq7HLrsN52NAcqXKaepeCD0n+B0arnVG3Hg==", "dev": true, "requires": { - "is-accessor-descriptor": "0.1.6", - "is-data-descriptor": "0.1.4", - "kind-of": "5.1.0" + "is-accessor-descriptor": "^0.1.6", + "is-data-descriptor": "^0.1.4", + "kind-of": "^5.0.0" }, "dependencies": { "kind-of": { @@ -2360,28 +1686,7 @@ "integrity": "sha1-lSHHaEXMJhCoUgPd8ICpWML/q8A=", "dev": true, "requires": { - "is-extglob": "2.1.1" - } - }, - "is-my-ip-valid": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-my-ip-valid/-/is-my-ip-valid-1.0.0.tgz", - "integrity": "sha512-gmh/eWXROncUzRnIa1Ubrt5b8ep/MGSnfAUI3aRp+sqTCs1tv1Isl8d8F6JmkN3dXKc3ehZMrtiPN9eL03NuaQ==", - "dev": true, - "optional": true - }, - "is-my-json-valid": { - "version": "2.17.2", - "resolved": "https://registry.npmjs.org/is-my-json-valid/-/is-my-json-valid-2.17.2.tgz", - "integrity": "sha512-IBhBslgngMQN8DDSppmgDv7RNrlFotuuDsKcrCP3+HbFaVivIBU7u9oiiErw8sH4ynx3+gOGQ3q2otkgiSi6kg==", - "dev": true, - "optional": true, - "requires": { - "generate-function": "2.0.0", - "generate-object-property": "1.2.0", - "is-my-ip-valid": "1.0.0", - "jsonpointer": "4.0.1", - "xtend": "4.0.1" + "is-extglob": "^2.1.1" } }, "is-number": { @@ -2390,7 +1695,7 @@ "integrity": "sha1-JP1iAaR4LPUFYcgQJ2r8fRLXEZU=", "dev": true, "requires": { - "kind-of": "3.2.2" + "kind-of": "^3.0.2" }, "dependencies": { "kind-of": { @@ -2399,7 +1704,7 @@ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", "dev": true, "requires": { - "is-buffer": "1.1.6" + "is-buffer": "^1.1.5" } } } @@ -2410,30 +1715,9 @@ "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", "dev": true, "requires": { - "isobject": "3.0.1" + "isobject": "^3.0.1" } }, - "is-property": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-property/-/is-property-1.0.2.tgz", - "integrity": "sha1-V/4cTkhHTt1lsJkR8msc1Ald2oQ=", - "dev": true, - "optional": true - }, - "is-stream": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", - "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", - "dev": true, - "optional": true - }, - "is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=", - "dev": true, - "optional": true - }, "is-windows": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", @@ -2447,10 +1731,13 @@ "dev": true }, "isbinaryfile": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/isbinaryfile/-/isbinaryfile-3.0.2.tgz", - "integrity": "sha1-Sj6XTsDLqQBNP8bN5yCeppNopiE=", - "dev": true + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/isbinaryfile/-/isbinaryfile-3.0.3.tgz", + "integrity": "sha512-8cJBL5tTd2OS0dM4jz07wQd5g0dCCqIhUxPIGtZfa5L6hWlvV5MHTITy/DBAsF+Oe2LS1X3krBUhNwaGUWpWxw==", + "dev": true, + "requires": { + "buffer-alloc": "^1.2.0" + } }, "isexe": { "version": "2.0.0", @@ -2464,97 +1751,43 @@ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", "dev": true }, - "isstream": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", - "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=", - "dev": true, - "optional": true - }, "jasmine-core": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/jasmine-core/-/jasmine-core-3.1.0.tgz", "integrity": "sha1-pHheE11d9lAk38kiSVPfWFvSdmw=", "dev": true }, - "jsbn": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", - "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=", - "dev": true, - "optional": true - }, - "json-schema": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", - "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=", - "dev": true, - "optional": true - }, - "json-schema-traverse": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.3.1.tgz", - "integrity": "sha1-NJptRMU6Ud6JtAgFxdXlm0F9M0A=", - "dev": true, - "optional": true - }, - "json-stringify-safe": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", - "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=", - "dev": true - }, - "jsonpointer": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-4.0.1.tgz", - "integrity": "sha1-T9kss04OnbPInIYi7PUfm5eMbLk=", - "dev": true, - "optional": true - }, - "jsprim": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", - "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", - "dev": true, - "optional": true, - "requires": { - "assert-plus": "1.0.0", - "extsprintf": "1.3.0", - "json-schema": "0.2.3", - "verror": "1.10.0" - } - }, "karma": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/karma/-/karma-2.0.4.tgz", - "integrity": "sha512-32yhTwoi6BZgJZhR78GwhzyFABbYG/1WwQqYgY7Vh96Demvua2jM3+FyRltIMTUH/Kd5xaQvDw2L7jTvkYFeXg==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/karma/-/karma-3.0.0.tgz", + "integrity": "sha512-ZTjyuDXVXhXsvJ1E4CnZzbCjSxD6sEdzEsFYogLuZM0yqvg/mgz+O+R1jb0J7uAQeuzdY8kJgx6hSNXLwFuHIQ==", "dev": true, "requires": { - "bluebird": "3.5.1", - "body-parser": "1.18.3", - "chokidar": "2.0.4", - "colors": "1.3.0", - "combine-lists": "1.0.1", - "connect": "3.6.6", - "core-js": "2.5.7", - "di": "0.0.1", - "dom-serialize": "2.2.1", - "expand-braces": "0.1.2", - "glob": "7.1.2", - "graceful-fs": "4.1.11", - "http-proxy": "1.17.0", - "isbinaryfile": "3.0.2", - "lodash": "4.17.10", - "log4js": "2.11.0", - "mime": "1.6.0", - "minimatch": "3.0.4", - "optimist": "0.6.1", - "qjobs": "1.2.0", - "range-parser": "1.2.0", - "rimraf": "2.6.2", - "safe-buffer": "5.1.2", - "socket.io": "2.0.4", - "source-map": "0.6.1", + "bluebird": "^3.3.0", + "body-parser": "^1.16.1", + "chokidar": "^2.0.3", + "colors": "^1.1.0", + "combine-lists": "^1.0.0", + "connect": "^3.6.0", + "core-js": "^2.2.0", + "di": "^0.0.1", + "dom-serialize": "^2.2.0", + "expand-braces": "^0.1.1", + "glob": "^7.1.1", + "graceful-fs": "^4.1.2", + "http-proxy": "^1.13.0", + "isbinaryfile": "^3.0.0", + "lodash": "^4.17.4", + "log4js": "^3.0.0", + "mime": "^2.3.1", + "minimatch": "^3.0.2", + "optimist": "^0.6.1", + "qjobs": "^1.1.4", + "range-parser": "^1.2.0", + "rimraf": "^2.6.0", + "safe-buffer": "^5.0.1", + "socket.io": "2.1.1", + "source-map": "^0.6.1", "tmp": "0.0.33", "useragent": "2.2.1" } @@ -2565,8 +1798,8 @@ "integrity": "sha512-uf/ZVpAabDBPvdPdveyk1EPgbnloPvFFGgmRhYLTDH7gEB4nZdSBk8yTU47w1g/drLSx5uMOkjKk7IWKfWg/+w==", "dev": true, "requires": { - "fs-access": "1.0.1", - "which": "1.3.1" + "fs-access": "^1.0.0", + "which": "^1.2.1" } }, "karma-firefox-launcher": { @@ -2587,48 +1820,6 @@ "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==", "dev": true }, - "levn": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz", - "integrity": "sha1-OwmSTt+fCDwEkP3UwLxEIeBHZO4=", - "dev": true, - "optional": true, - "requires": { - "prelude-ls": "1.1.2", - "type-check": "0.3.2" - } - }, - "libbase64": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/libbase64/-/libbase64-0.1.0.tgz", - "integrity": "sha1-YjUag5VjrF/1vSbxL2Dpgwu3UeY=", - "dev": true - }, - "libmime": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/libmime/-/libmime-3.0.0.tgz", - "integrity": "sha1-UaGp50SOy9Ms2lRCFnW7IbwJPaY=", - "dev": true, - "requires": { - "iconv-lite": "0.4.15", - "libbase64": "0.1.0", - "libqp": "1.1.0" - }, - "dependencies": { - "iconv-lite": { - "version": "0.4.15", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.15.tgz", - "integrity": "sha1-/iZaIYrGpXz+hUkn6dBMGYJe3es=", - "dev": true - } - } - }, - "libqp": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/libqp/-/libqp-1.1.0.tgz", - "integrity": "sha1-9ebgatdLeU+1tbZpiL9yjvHe2+g=", - "dev": true - }, "lodash": { "version": "4.17.10", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.10.tgz", @@ -2642,23 +1833,15 @@ "dev": true }, "log4js": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/log4js/-/log4js-2.11.0.tgz", - "integrity": "sha512-z1XdwyGFg8/WGkOyF6DPJjivCWNLKrklGdViywdYnSKOvgtEBo2UyEMZS5sD2mZrQlU3TvO8wDWLc8mzE1ncBQ==", + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/log4js/-/log4js-3.0.5.tgz", + "integrity": "sha512-IX5c3G/7fuTtdr0JjOT2OIR12aTESVhsH6cEsijloYwKgcPRlO6DgOU72v0UFhWcoV1HN6+M3dwT89qVPLXm0w==", "dev": true, "requires": { - "amqplib": "0.5.2", - "axios": "0.15.3", - "circular-json": "0.5.5", - "date-format": "1.2.0", - "debug": "3.1.0", - "hipchat-notifier": "1.1.0", - "loggly": "1.1.1", - "mailgun-js": "0.18.1", - "nodemailer": "2.7.2", - "redis": "2.8.0", - "semver": "5.5.0", - "slack-node": "0.2.0", + "circular-json": "^0.5.5", + "date-format": "^1.2.0", + "debug": "^3.1.0", + "rfdc": "^1.1.2", "streamroller": "0.7.0" }, "dependencies": { @@ -2673,180 +1856,11 @@ } } }, - "loggly": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/loggly/-/loggly-1.1.1.tgz", - "integrity": "sha1-Cg/B0/o6XsRP3HuJe+uipGlc6+4=", - "dev": true, - "optional": true, - "requires": { - "json-stringify-safe": "5.0.1", - "request": "2.75.0", - "timespan": "2.3.0" - }, - "dependencies": { - "assert-plus": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-0.2.0.tgz", - "integrity": "sha1-104bh+ev/A24qttwIfP+SBAasjQ=", - "dev": true, - "optional": true - }, - "aws-sign2": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.6.0.tgz", - "integrity": "sha1-FDQt0428yU0OW4fXY81jYSwOeU8=", - "dev": true, - "optional": true - }, - "caseless": { - "version": "0.11.0", - "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.11.0.tgz", - "integrity": "sha1-cVuW6phBWTzDMGeSP17GDr2k99c=", - "dev": true, - "optional": true - }, - "form-data": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.0.0.tgz", - "integrity": "sha1-bwrrrcxdoWwT4ezBETfYX5uIOyU=", - "dev": true, - "optional": true, - "requires": { - "asynckit": "0.4.0", - "combined-stream": "1.0.6", - "mime-types": "2.1.19" - } - }, - "har-validator": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-2.0.6.tgz", - "integrity": "sha1-zcvAgYgmWtEZtqWnyKtw7s+10n0=", - "dev": true, - "optional": true, - "requires": { - "chalk": "1.1.3", - "commander": "2.16.0", - "is-my-json-valid": "2.17.2", - "pinkie-promise": "2.0.1" - } - }, - "http-signature": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.1.1.tgz", - "integrity": "sha1-33LiZwZs0Kxn+3at+OE0qPvPkb8=", - "dev": true, - "optional": true, - "requires": { - "assert-plus": "0.2.0", - "jsprim": "1.4.1", - "sshpk": "1.14.2" - } - }, - "node-uuid": { - "version": "1.4.8", - "resolved": "https://registry.npmjs.org/node-uuid/-/node-uuid-1.4.8.tgz", - "integrity": "sha1-sEDrCSOWivq/jTL7HxfxFn/auQc=", - "dev": true, - "optional": true - }, - "qs": { - "version": "6.2.3", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.2.3.tgz", - "integrity": "sha1-HPyyXBCpsrSDBT/zn138kjOQjP4=", - "dev": true, - "optional": true - }, - "request": { - "version": "2.75.0", - "resolved": "https://registry.npmjs.org/request/-/request-2.75.0.tgz", - "integrity": "sha1-0rgmiihtoT6qXQGt9dGMyQ9lfZM=", - "dev": true, - "optional": true, - "requires": { - "aws-sign2": "0.6.0", - "aws4": "1.7.0", - "bl": "1.1.2", - "caseless": "0.11.0", - "combined-stream": "1.0.6", - "extend": "3.0.2", - "forever-agent": "0.6.1", - "form-data": "2.0.0", - "har-validator": "2.0.6", - "hawk": "3.1.3", - "http-signature": "1.1.1", - "is-typedarray": "1.0.0", - "isstream": "0.1.2", - "json-stringify-safe": "5.0.1", - "mime-types": "2.1.19", - "node-uuid": "1.4.8", - "oauth-sign": "0.8.2", - "qs": "6.2.3", - "stringstream": "0.0.6", - "tough-cookie": "2.3.4", - "tunnel-agent": "0.4.3" - } - }, - "tunnel-agent": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.4.3.tgz", - "integrity": "sha1-Y3PbdpCf5XDgjXNYM2Xtgop07us=", - "dev": true, - "optional": true - } - } - }, "lru-cache": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.3.tgz", - "integrity": "sha512-fFEhvcgzuIoJVUF8fYr5KR0YqxD238zgObTps31YdADwPPAp82a4M8TrckkWyx7ekNlf9aBcVn81cFwwXngrJA==", - "dev": true, - "optional": true, - "requires": { - "pseudomap": "1.0.2", - "yallist": "2.1.2" - } - }, - "mailcomposer": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/mailcomposer/-/mailcomposer-4.0.1.tgz", - "integrity": "sha1-DhxEsqB890DuF9wUm6AJ8Zyt/rQ=", - "dev": true, - "optional": true, - "requires": { - "buildmail": "4.0.1", - "libmime": "3.0.0" - } - }, - "mailgun-js": { - "version": "0.18.1", - "resolved": "https://registry.npmjs.org/mailgun-js/-/mailgun-js-0.18.1.tgz", - "integrity": "sha512-lvuMP14u24HS2uBsJEnzSyPMxzU2b99tQsIx1o6QNjqxjk8b3WvR+vq5oG1mjqz/IBYo+5gF+uSoDS0RkMVHmg==", - "dev": true, - "optional": true, - "requires": { - "async": "2.6.1", - "debug": "3.1.0", - "form-data": "2.3.2", - "inflection": "1.12.0", - "is-stream": "1.1.0", - "path-proxy": "1.0.0", - "promisify-call": "2.0.4", - "proxy-agent": "3.0.1", - "tsscmp": "1.0.5" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "optional": true, - "requires": { - "ms": "2.0.0" - } - } - } + "version": "2.2.4", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-2.2.4.tgz", + "integrity": "sha1-bGWGGb7PFAMdDQtZSxYELOTcBj0=", + "dev": true }, "map-cache": { "version": "0.2.2", @@ -2860,7 +1874,7 @@ "integrity": "sha1-7Nyo8TFE5mDxtb1B8S80edmN+48=", "dev": true, "requires": { - "object-visit": "1.0.1" + "object-visit": "^1.0.0" } }, "media-typer": { @@ -2875,25 +1889,25 @@ "integrity": "sha512-MWikgl9n9M3w+bpsY3He8L+w9eF9338xRl8IAO5viDizwSzziFEyUzo2xrrloB64ADbTf8uA8vRqqttDTOmccg==", "dev": true, "requires": { - "arr-diff": "4.0.0", - "array-unique": "0.3.2", - "braces": "2.3.2", - "define-property": "2.0.2", - "extend-shallow": "3.0.2", - "extglob": "2.0.4", - "fragment-cache": "0.2.1", - "kind-of": "6.0.2", - "nanomatch": "1.2.13", - "object.pick": "1.3.0", - "regex-not": "1.0.2", - "snapdragon": "0.8.2", - "to-regex": "3.0.2" + "arr-diff": "^4.0.0", + "array-unique": "^0.3.2", + "braces": "^2.3.1", + "define-property": "^2.0.2", + "extend-shallow": "^3.0.2", + "extglob": "^2.0.4", + "fragment-cache": "^0.2.1", + "kind-of": "^6.0.2", + "nanomatch": "^1.2.9", + "object.pick": "^1.3.0", + "regex-not": "^1.0.0", + "snapdragon": "^0.8.1", + "to-regex": "^3.0.2" } }, "mime": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", - "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/mime/-/mime-2.3.1.tgz", + "integrity": "sha512-OEUllcVoydBHGN1z84yfQDimn58pZNNNXgZlHXSboxMlFvgI6MXSWpWKpFRra7H1HxpVhHTkrghfRW49k6yjeg==", "dev": true }, "mime-db": { @@ -2908,7 +1922,7 @@ "integrity": "sha512-P1tKYHVSZ6uFo26mtnve4HQFE3koh1UWVkp8YUC+ESBHe945xWSoXuHHiGarDqcEZ+whpCDnlNw5LON0kLo+sw==", "dev": true, "requires": { - "mime-db": "1.35.0" + "mime-db": "~1.35.0" } }, "minimatch": { @@ -2917,7 +1931,7 @@ "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", "dev": true, "requires": { - "brace-expansion": "1.1.11" + "brace-expansion": "^1.1.7" } }, "minimist": { @@ -2932,8 +1946,8 @@ "integrity": "sha512-8ZItLHeEgaqEvd5lYBXfm4EZSFCX29Jb9K+lAHhDKzReKBQKj3R+7NOF6tjqYi9t4oI8VUfaWITJQm86wnXGNQ==", "dev": true, "requires": { - "for-in": "1.0.2", - "is-extendable": "1.0.1" + "for-in": "^1.0.2", + "is-extendable": "^1.0.1" }, "dependencies": { "is-extendable": { @@ -2942,7 +1956,7 @@ "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", "dev": true, "requires": { - "is-plain-object": "2.0.4" + "is-plain-object": "^2.0.4" } } } @@ -2975,17 +1989,17 @@ "integrity": "sha512-fpoe2T0RbHwBTBUOftAfBPaDEi06ufaUai0mE6Yn1kacc3SnTErfb/h+X94VXzI64rKFHYImXSvdwGGCmwOqCA==", "dev": true, "requires": { - "arr-diff": "4.0.0", - "array-unique": "0.3.2", - "define-property": "2.0.2", - "extend-shallow": "3.0.2", - "fragment-cache": "0.2.1", - "is-windows": "1.0.2", - "kind-of": "6.0.2", - "object.pick": "1.3.0", - "regex-not": "1.0.2", - "snapdragon": "0.8.2", - "to-regex": "3.0.2" + "arr-diff": "^4.0.0", + "array-unique": "^0.3.2", + "define-property": "^2.0.2", + "extend-shallow": "^3.0.2", + "fragment-cache": "^0.2.1", + "is-windows": "^1.0.2", + "kind-of": "^6.0.2", + "object.pick": "^1.3.0", + "regex-not": "^1.0.0", + "snapdragon": "^0.8.1", + "to-regex": "^3.0.1" } }, "negotiator": { @@ -2994,105 +2008,13 @@ "integrity": "sha1-KzJxhOiZIQEXeyhWP7XnECrNDKk=", "dev": true }, - "netmask": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/netmask/-/netmask-1.0.6.tgz", - "integrity": "sha1-ICl+idhvb2QA8lDZ9Pa0wZRfzTU=", - "dev": true, - "optional": true - }, - "nodemailer": { - "version": "2.7.2", - "resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-2.7.2.tgz", - "integrity": "sha1-8kLmSa7q45tsftdA73sGHEBNMPk=", - "dev": true, - "optional": true, - "requires": { - "libmime": "3.0.0", - "mailcomposer": "4.0.1", - "nodemailer-direct-transport": "3.3.2", - "nodemailer-shared": "1.1.0", - "nodemailer-smtp-pool": "2.8.2", - "nodemailer-smtp-transport": "2.7.2", - "socks": "1.1.9" - }, - "dependencies": { - "socks": { - "version": "1.1.9", - "resolved": "https://registry.npmjs.org/socks/-/socks-1.1.9.tgz", - "integrity": "sha1-Yo1+TQSRJDVEWsC25Fk3bLPm1pE=", - "dev": true, - "optional": true, - "requires": { - "ip": "1.1.5", - "smart-buffer": "1.1.15" - } - } - } - }, - "nodemailer-direct-transport": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/nodemailer-direct-transport/-/nodemailer-direct-transport-3.3.2.tgz", - "integrity": "sha1-6W+vuQNYVglH5WkBfZfmBzilCoY=", - "dev": true, - "optional": true, - "requires": { - "nodemailer-shared": "1.1.0", - "smtp-connection": "2.12.0" - } - }, - "nodemailer-fetch": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/nodemailer-fetch/-/nodemailer-fetch-1.6.0.tgz", - "integrity": "sha1-ecSQihwPXzdbc/6IjamCj23JY6Q=", - "dev": true - }, - "nodemailer-shared": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/nodemailer-shared/-/nodemailer-shared-1.1.0.tgz", - "integrity": "sha1-z1mU4v0mjQD1zw+nZ6CBae2wfsA=", - "dev": true, - "requires": { - "nodemailer-fetch": "1.6.0" - } - }, - "nodemailer-smtp-pool": { - "version": "2.8.2", - "resolved": "https://registry.npmjs.org/nodemailer-smtp-pool/-/nodemailer-smtp-pool-2.8.2.tgz", - "integrity": "sha1-LrlNbPhXgLG0clzoU7nL1ejajHI=", - "dev": true, - "optional": true, - "requires": { - "nodemailer-shared": "1.1.0", - "nodemailer-wellknown": "0.1.10", - "smtp-connection": "2.12.0" - } - }, - "nodemailer-smtp-transport": { - "version": "2.7.2", - "resolved": "https://registry.npmjs.org/nodemailer-smtp-transport/-/nodemailer-smtp-transport-2.7.2.tgz", - "integrity": "sha1-A9ccdjFPFKx9vHvwM6am0W1n+3c=", - "dev": true, - "optional": true, - "requires": { - "nodemailer-shared": "1.1.0", - "nodemailer-wellknown": "0.1.10", - "smtp-connection": "2.12.0" - } - }, - "nodemailer-wellknown": { - "version": "0.1.10", - "resolved": "https://registry.npmjs.org/nodemailer-wellknown/-/nodemailer-wellknown-0.1.10.tgz", - "integrity": "sha1-WG24EB2zDLRDjrVGc3pBqtDPE9U=", - "dev": true - }, "normalize-path": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=", "dev": true, "requires": { - "remove-trailing-separator": "1.1.0" + "remove-trailing-separator": "^1.0.1" } }, "null-check": { @@ -3101,13 +2023,6 @@ "integrity": "sha1-l33/1xdgErnsMNKjnbXPcqBDnt0=", "dev": true }, - "oauth-sign": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.8.2.tgz", - "integrity": "sha1-Rqarfwrq2N6unsBWV4C31O/rnUM=", - "dev": true, - "optional": true - }, "object-component": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/object-component/-/object-component-0.0.3.tgz", @@ -3120,9 +2035,9 @@ "integrity": "sha1-fn2Fi3gb18mRpBupde04EnVOmYw=", "dev": true, "requires": { - "copy-descriptor": "0.1.1", - "define-property": "0.2.5", - "kind-of": "3.2.2" + "copy-descriptor": "^0.1.0", + "define-property": "^0.2.5", + "kind-of": "^3.0.3" }, "dependencies": { "define-property": { @@ -3131,7 +2046,7 @@ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, "requires": { - "is-descriptor": "0.1.6" + "is-descriptor": "^0.1.0" } }, "kind-of": { @@ -3140,7 +2055,7 @@ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", "dev": true, "requires": { - "is-buffer": "1.1.6" + "is-buffer": "^1.1.5" } } } @@ -3151,7 +2066,7 @@ "integrity": "sha1-95xEk68MU3e1n+OdOV5BBC3QRbs=", "dev": true, "requires": { - "isobject": "3.0.1" + "isobject": "^3.0.0" } }, "object.pick": { @@ -3160,7 +2075,7 @@ "integrity": "sha1-h6EKxMFpS9Lhy/U1kaZhQftd10c=", "dev": true, "requires": { - "isobject": "3.0.1" + "isobject": "^3.0.1" } }, "on-finished": { @@ -3178,7 +2093,7 @@ "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", "dev": true, "requires": { - "wrappy": "1.0.2" + "wrappy": "1" } }, "optimist": { @@ -3187,31 +2102,8 @@ "integrity": "sha1-2j6nRob6IaGaERwybpDrFaAZZoY=", "dev": true, "requires": { - "minimist": "0.0.8", - "wordwrap": "0.0.3" - }, - "dependencies": { - "wordwrap": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz", - "integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=", - "dev": true - } - } - }, - "optionator": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.2.tgz", - "integrity": "sha1-NkxeQJ0/TWMB1sC0wFu6UBgK62Q=", - "dev": true, - "optional": true, - "requires": { - "deep-is": "0.1.3", - "fast-levenshtein": "2.0.6", - "levn": "0.3.0", - "prelude-ls": "1.1.2", - "type-check": "0.3.2", - "wordwrap": "1.0.0" + "minimist": "~0.0.1", + "wordwrap": "~0.0.2" } }, "os-tmpdir": { @@ -3220,67 +2112,13 @@ "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=", "dev": true }, - "pac-proxy-agent": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/pac-proxy-agent/-/pac-proxy-agent-2.0.2.tgz", - "integrity": "sha512-cDNAN1Ehjbf5EHkNY5qnRhGPUCp6SnpyVof5fRzN800QV1Y2OkzbH9rmjZkbBRa8igof903yOnjIl6z0SlAhxA==", - "dev": true, - "optional": true, - "requires": { - "agent-base": "4.2.1", - "debug": "3.1.0", - "get-uri": "2.0.2", - "http-proxy-agent": "2.1.0", - "https-proxy-agent": "2.2.1", - "pac-resolver": "3.0.0", - "raw-body": "2.3.3", - "socks-proxy-agent": "3.0.1" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "optional": true, - "requires": { - "ms": "2.0.0" - } - }, - "socks-proxy-agent": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-3.0.1.tgz", - "integrity": "sha512-ZwEDymm204mTzvdqyUqOdovVr2YRd2NYskrYrF2LXyZ9qDiMAoFESGK8CRphiO7rtbo2Y757k2Nia3x2hGtalA==", - "dev": true, - "optional": true, - "requires": { - "agent-base": "4.2.1", - "socks": "1.1.10" - } - } - } - }, - "pac-resolver": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pac-resolver/-/pac-resolver-3.0.0.tgz", - "integrity": "sha512-tcc38bsjuE3XZ5+4vP96OfhOugrX+JcnpUbhfuc4LuXBLQhoTthOstZeoQJBDnQUDYzYmdImKsbz0xSl1/9qeA==", - "dev": true, - "optional": true, - "requires": { - "co": "4.6.0", - "degenerator": "1.0.4", - "ip": "1.1.5", - "netmask": "1.0.6", - "thunkify": "2.1.2" - } - }, "parseqs": { "version": "0.0.5", "resolved": "https://registry.npmjs.org/parseqs/-/parseqs-0.0.5.tgz", "integrity": "sha1-1SCKNzjkZ2bikbouoXNoSSGouJ0=", "dev": true, "requires": { - "better-assert": "1.0.2" + "better-assert": "~1.0.0" } }, "parseuri": { @@ -3289,7 +2127,7 @@ "integrity": "sha1-gCBKUNTbt3m/3G6+J3jZDkvOMgo=", "dev": true, "requires": { - "better-assert": "1.0.2" + "better-assert": "~1.0.0" } }, "parseurl": { @@ -3316,127 +2154,18 @@ "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", "dev": true }, - "path-proxy": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/path-proxy/-/path-proxy-1.0.0.tgz", - "integrity": "sha1-GOijaFn8nS8aU7SN7hOFQ8Ag3l4=", - "dev": true, - "optional": true, - "requires": { - "inflection": "1.3.8" - }, - "dependencies": { - "inflection": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/inflection/-/inflection-1.3.8.tgz", - "integrity": "sha1-y9Fg2p91sUw8xjV41POWeEvzAU4=", - "dev": true, - "optional": true - } - } - }, - "performance-now": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", - "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=", - "dev": true, - "optional": true - }, - "pinkie": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/pinkie/-/pinkie-2.0.4.tgz", - "integrity": "sha1-clVrgM+g1IqXToDnckjoDtT3+HA=", - "dev": true, - "optional": true - }, - "pinkie-promise": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/pinkie-promise/-/pinkie-promise-2.0.1.tgz", - "integrity": "sha1-ITXW36ejWMBprJsXh3YogihFD/o=", - "dev": true, - "optional": true, - "requires": { - "pinkie": "2.0.4" - } - }, "posix-character-classes": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz", "integrity": "sha1-AerA/jta9xoqbAL+q7jB/vfgDqs=", "dev": true }, - "prelude-ls": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz", - "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", - "dev": true - }, "process-nextick-args": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.0.tgz", "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==", "dev": true }, - "promisify-call": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/promisify-call/-/promisify-call-2.0.4.tgz", - "integrity": "sha1-1IwtRWUszM1SgB3ey9UzptS9X7o=", - "dev": true, - "optional": true, - "requires": { - "with-callback": "1.0.2" - } - }, - "proxy-agent": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/proxy-agent/-/proxy-agent-3.0.1.tgz", - "integrity": "sha512-mAZexaz9ZxQhYPWfAjzlrloEjW+JHiBFryE4AJXFDTnaXfmH/FKqC1swTRKuEPbHWz02flQNXFOyDUF7zfEG6A==", - "dev": true, - "optional": true, - "requires": { - "agent-base": "4.2.1", - "debug": "3.1.0", - "http-proxy-agent": "2.1.0", - "https-proxy-agent": "2.2.1", - "lru-cache": "4.1.3", - "pac-proxy-agent": "2.0.2", - "proxy-from-env": "1.0.0", - "socks-proxy-agent": "4.0.1" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "optional": true, - "requires": { - "ms": "2.0.0" - } - } - } - }, - "proxy-from-env": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.0.0.tgz", - "integrity": "sha1-M8UDmPcOp+uW0h97gXYwpVeRx+4=", - "dev": true, - "optional": true - }, - "pseudomap": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz", - "integrity": "sha1-8FKijacOYYkX7wqKw0wa5aaChrM=", - "dev": true, - "optional": true - }, - "punycode": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", - "integrity": "sha1-wNWmOycYgArY4esPpSachN1BhF4=", - "dev": true, - "optional": true - }, "qjobs": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/qjobs/-/qjobs-1.2.0.tgz", @@ -3473,13 +2202,13 @@ "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", "dev": true, "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "1.0.0", - "process-nextick-args": "2.0.0", - "safe-buffer": "5.1.2", - "string_decoder": "1.1.1", - "util-deprecate": "1.0.2" + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" } }, "readdirp": { @@ -3488,46 +2217,20 @@ "integrity": "sha1-TtCtBg3zBzMAxIRANz9y0cxkLXg=", "dev": true, "requires": { - "graceful-fs": "4.1.11", - "minimatch": "3.0.4", - "readable-stream": "2.3.6", - "set-immediate-shim": "1.0.1" + "graceful-fs": "^4.1.2", + "minimatch": "^3.0.2", + "readable-stream": "^2.0.2", + "set-immediate-shim": "^1.0.1" } }, - "redis": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/redis/-/redis-2.8.0.tgz", - "integrity": "sha512-M1OkonEQwtRmZv4tEWF2VgpG0JWJ8Fv1PhlgT5+B+uNq2cA3Rt1Yt/ryoR+vQNOQcIEgdCdfH0jr3bDpihAw1A==", - "dev": true, - "optional": true, - "requires": { - "double-ended-queue": "2.1.0-0", - "redis-commands": "1.3.5", - "redis-parser": "2.6.0" - } - }, - "redis-commands": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.3.5.tgz", - "integrity": "sha512-foGF8u6MXGFF++1TZVC6icGXuMYPftKXt1FBT2vrfU9ZATNtZJ8duRC5d1lEfE8hyVe3jhelHGB91oB7I6qLsA==", - "dev": true, - "optional": true - }, - "redis-parser": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/redis-parser/-/redis-parser-2.6.0.tgz", - "integrity": "sha1-Uu0J2srBCPGmMcB+m2mUHnoZUEs=", - "dev": true, - "optional": true - }, "regex-not": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz", "integrity": "sha512-J6SDjUgDxQj5NusnOtdFxDwN/+HWykR8GELwctJ7mdqhcyy1xEc4SRFHUXvxTp661YaVKAjfRLZ9cCqS6tn32A==", "dev": true, "requires": { - "extend-shallow": "3.0.2", - "safe-regex": "1.1.0" + "extend-shallow": "^3.0.2", + "safe-regex": "^1.1.0" } }, "remove-trailing-separator": { @@ -3548,48 +2251,6 @@ "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", "dev": true }, - "request": { - "version": "2.87.0", - "resolved": "https://registry.npmjs.org/request/-/request-2.87.0.tgz", - "integrity": "sha512-fcogkm7Az5bsS6Sl0sibkbhcKsnyon/jV1kF3ajGmF0c8HrttdKTPRT9hieOaQHA5HEq6r8OyWOo/o781C1tNw==", - "dev": true, - "optional": true, - "requires": { - "aws-sign2": "0.7.0", - "aws4": "1.7.0", - "caseless": "0.12.0", - "combined-stream": "1.0.6", - "extend": "3.0.2", - "forever-agent": "0.6.1", - "form-data": "2.3.2", - "har-validator": "5.0.3", - "http-signature": "1.2.0", - "is-typedarray": "1.0.0", - "isstream": "0.1.2", - "json-stringify-safe": "5.0.1", - "mime-types": "2.1.19", - "oauth-sign": "0.8.2", - "performance-now": "2.1.0", - "qs": "6.5.2", - "safe-buffer": "5.1.2", - "tough-cookie": "2.3.4", - "tunnel-agent": "0.6.0", - "uuid": "3.3.2" - } - }, - "requestretry": { - "version": "1.13.0", - "resolved": "https://registry.npmjs.org/requestretry/-/requestretry-1.13.0.tgz", - "integrity": "sha512-Lmh9qMvnQXADGAQxsXHP4rbgO6pffCfuR8XUBdP9aitJcLQJxhp7YZK4xAVYXnPJ5E52mwrfiKQtKonPL8xsmg==", - "dev": true, - "optional": true, - "requires": { - "extend": "3.0.2", - "lodash": "4.17.10", - "request": "2.87.0", - "when": "3.7.8" - } - }, "requires-port": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", @@ -3608,13 +2269,19 @@ "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", "dev": true }, + "rfdc": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.1.2.tgz", + "integrity": "sha512-92ktAgvZhBzYTIK0Mja9uen5q5J3NRVMoDkJL2VMwq6SXjVCgqvQeVP2XAaUY6HT+XpQYeLSjb3UoitBryKmdA==", + "dev": true + }, "rimraf": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.2.tgz", "integrity": "sha512-lreewLK/BlghmxtfH36YYVg1i8IAce4TI7oao75I1g245+6BctqTVQiBP3YUJ9C6DQOXJmkYR9X9fCLtCOJc5w==", "dev": true, "requires": { - "glob": "7.1.2" + "glob": "^7.0.5" } }, "safe-buffer": { @@ -3629,7 +2296,7 @@ "integrity": "sha1-QKNmnzsHfR6UPURinhV91IAjvy4=", "dev": true, "requires": { - "ret": "0.1.15" + "ret": "~0.1.10" } }, "safer-buffer": { @@ -3638,12 +2305,6 @@ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "dev": true }, - "semver": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.5.0.tgz", - "integrity": "sha512-4SJ3dm0WAwWy/NVeioZh5AntkdJoWKxHxcmyP622fOkgHa4z3R0TdBJICINyaSDE6uNwVc8gZr+ZinwZAH4xIA==", - "dev": true - }, "set-immediate-shim": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/set-immediate-shim/-/set-immediate-shim-1.0.1.tgz", @@ -3656,10 +2317,10 @@ "integrity": "sha512-hw0yxk9GT/Hr5yJEYnHNKYXkIA8mVJgd9ditYZCe16ZczcaELYYcfvaXesNACk2O8O0nTiPQcQhGUQj8JLzeeg==", "dev": true, "requires": { - "extend-shallow": "2.0.1", - "is-extendable": "0.1.1", - "is-plain-object": "2.0.4", - "split-string": "3.1.0" + "extend-shallow": "^2.0.1", + "is-extendable": "^0.1.1", + "is-plain-object": "^2.0.3", + "split-string": "^3.0.1" }, "dependencies": { "extend-shallow": { @@ -3668,7 +2329,7 @@ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, "requires": { - "is-extendable": "0.1.1" + "is-extendable": "^0.1.0" } } } @@ -3679,47 +2340,20 @@ "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==", "dev": true }, - "slack-node": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/slack-node/-/slack-node-0.2.0.tgz", - "integrity": "sha1-3kuN3aqLeT9h29KTgQT9q/N9+jA=", - "dev": true, - "optional": true, - "requires": { - "requestretry": "1.13.0" - } - }, - "smart-buffer": { - "version": "1.1.15", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-1.1.15.tgz", - "integrity": "sha1-fxFLW2X6s+KjWqd1uxLw0cZJvxY=", - "dev": true, - "optional": true - }, - "smtp-connection": { - "version": "2.12.0", - "resolved": "https://registry.npmjs.org/smtp-connection/-/smtp-connection-2.12.0.tgz", - "integrity": "sha1-1275EnyyPCJZ7bHoNJwujV4tdME=", - "dev": true, - "requires": { - "httpntlm": "1.6.1", - "nodemailer-shared": "1.1.0" - } - }, "snapdragon": { "version": "0.8.2", "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz", "integrity": "sha512-FtyOnWN/wCHTVXOMwvSv26d+ko5vWlIDD6zoUJ7LW8vh+ZBC8QdljveRP+crNrtBwioEUWy/4dMtbBjA4ioNlg==", "dev": true, "requires": { - "base": "0.11.2", - "debug": "2.6.9", - "define-property": "0.2.5", - "extend-shallow": "2.0.1", - "map-cache": "0.2.2", - "source-map": "0.5.7", - "source-map-resolve": "0.5.2", - "use": "3.1.1" + "base": "^0.11.1", + "debug": "^2.2.0", + "define-property": "^0.2.5", + "extend-shallow": "^2.0.1", + "map-cache": "^0.2.2", + "source-map": "^0.5.6", + "source-map-resolve": "^0.5.0", + "use": "^3.1.0" }, "dependencies": { "define-property": { @@ -3728,7 +2362,7 @@ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, "requires": { - "is-descriptor": "0.1.6" + "is-descriptor": "^0.1.0" } }, "extend-shallow": { @@ -3737,7 +2371,7 @@ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, "requires": { - "is-extendable": "0.1.1" + "is-extendable": "^0.1.0" } }, "source-map": { @@ -3754,9 +2388,9 @@ "integrity": "sha512-O27l4xaMYt/RSQ5TR3vpWCAB5Kb/czIcqUFOM/C4fYcLnbZUc1PkjTAMjof2pBWaSTwOUd6qUHcFGVGj7aIwnw==", "dev": true, "requires": { - "define-property": "1.0.0", - "isobject": "3.0.1", - "snapdragon-util": "3.0.1" + "define-property": "^1.0.0", + "isobject": "^3.0.0", + "snapdragon-util": "^3.0.1" }, "dependencies": { "define-property": { @@ -3765,7 +2399,7 @@ "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", "dev": true, "requires": { - "is-descriptor": "1.0.2" + "is-descriptor": "^1.0.0" } }, "is-accessor-descriptor": { @@ -3774,7 +2408,7 @@ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-data-descriptor": { @@ -3783,7 +2417,7 @@ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", "dev": true, "requires": { - "kind-of": "6.0.2" + "kind-of": "^6.0.0" } }, "is-descriptor": { @@ -3792,9 +2426,9 @@ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", "dev": true, "requires": { - "is-accessor-descriptor": "1.0.0", - "is-data-descriptor": "1.0.0", - "kind-of": "6.0.2" + "is-accessor-descriptor": "^1.0.0", + "is-data-descriptor": "^1.0.0", + "kind-of": "^6.0.2" } } } @@ -3805,7 +2439,7 @@ "integrity": "sha512-mbKkMdQKsjX4BAL4bRYTj21edOf8cN7XHdYUJEe+Zn99hVEYcMvKPct1IqNe7+AZPirn8BCDOQBHQZknqmKlZQ==", "dev": true, "requires": { - "kind-of": "3.2.2" + "kind-of": "^3.2.0" }, "dependencies": { "kind-of": { @@ -3814,32 +2448,34 @@ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", "dev": true, "requires": { - "is-buffer": "1.1.6" + "is-buffer": "^1.1.5" } } } }, - "sntp": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/sntp/-/sntp-1.0.9.tgz", - "integrity": "sha1-ZUEYTMkK7qbG57NeJlkIJEPGYZg=", - "dev": true, - "optional": true, - "requires": { - "hoek": "2.16.3" - } - }, "socket.io": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-2.0.4.tgz", - "integrity": "sha1-waRZDO/4fs8TxyZS8Eb3FrKeYBQ=", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-2.1.1.tgz", + "integrity": "sha512-rORqq9c+7W0DAK3cleWNSyfv/qKXV99hV4tZe+gGLfBECw3XEhBy7x85F3wypA9688LKjtwO9pX9L33/xQI8yA==", "dev": true, "requires": { - "debug": "2.6.9", - "engine.io": "3.1.5", - "socket.io-adapter": "1.1.1", - "socket.io-client": "2.0.4", - "socket.io-parser": "3.1.3" + "debug": "~3.1.0", + "engine.io": "~3.2.0", + "has-binary2": "~1.0.2", + "socket.io-adapter": "~1.1.0", + "socket.io-client": "2.1.1", + "socket.io-parser": "~3.2.0" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } } }, "socket.io-adapter": { @@ -3849,35 +2485,46 @@ "dev": true }, "socket.io-client": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-2.0.4.tgz", - "integrity": "sha1-CRilUkBtxeVAs4Dc2Xr8SmQzL44=", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-2.1.1.tgz", + "integrity": "sha512-jxnFyhAuFxYfjqIgduQlhzqTcOEQSn+OHKVfAxWaNWa7ecP7xSNk2Dx/3UEsDcY7NcFafxvNvKPmmO7HTwTxGQ==", "dev": true, "requires": { "backo2": "1.0.2", "base64-arraybuffer": "0.1.5", "component-bind": "1.0.0", "component-emitter": "1.2.1", - "debug": "2.6.9", - "engine.io-client": "3.1.6", + "debug": "~3.1.0", + "engine.io-client": "~3.2.0", + "has-binary2": "~1.0.2", "has-cors": "1.1.0", "indexof": "0.0.1", "object-component": "0.0.3", "parseqs": "0.0.5", "parseuri": "0.0.5", - "socket.io-parser": "3.1.3", + "socket.io-parser": "~3.2.0", "to-array": "0.1.4" + }, + "dependencies": { + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", + "dev": true, + "requires": { + "ms": "2.0.0" + } + } } }, "socket.io-parser": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-3.1.3.tgz", - "integrity": "sha512-g0a2HPqLguqAczs3dMECuA1RgoGFPyvDqcbaDEdCWY9g59kdUAz3YRmaJBNKXflrHNwB7Q12Gkf/0CZXfdHR7g==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-3.2.0.tgz", + "integrity": "sha512-FYiBx7rc/KORMJlgsXysflWx/RIvtqZbyGLlHZvjfmPTPeuD/I8MaW7cfFrj5tRltICJdgwflhfZ3NVVbVLFQA==", "dev": true, "requires": { "component-emitter": "1.2.1", - "debug": "3.1.0", - "has-binary2": "1.0.3", + "debug": "~3.1.0", "isarray": "2.0.1" }, "dependencies": { @@ -3898,48 +2545,6 @@ } } }, - "socks": { - "version": "1.1.10", - "resolved": "https://registry.npmjs.org/socks/-/socks-1.1.10.tgz", - "integrity": "sha1-W4t/x8jzQcU+0FbpKbe/Tei6e1o=", - "dev": true, - "optional": true, - "requires": { - "ip": "1.1.5", - "smart-buffer": "1.1.15" - } - }, - "socks-proxy-agent": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-4.0.1.tgz", - "integrity": "sha512-Kezx6/VBguXOsEe5oU3lXYyKMi4+gva72TwJ7pQY5JfqUx2nMk7NXA6z/mpNqIlfQjWYVfeuNvQjexiTaTn6Nw==", - "dev": true, - "optional": true, - "requires": { - "agent-base": "4.2.1", - "socks": "2.2.1" - }, - "dependencies": { - "smart-buffer": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.0.1.tgz", - "integrity": "sha512-RFqinRVJVcCAL9Uh1oVqE6FZkqsyLiVOYEZ20TqIOjuX7iFVJ+zsbs4RIghnw/pTs7mZvt8ZHhvm1ZUrR4fykg==", - "dev": true, - "optional": true - }, - "socks": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/socks/-/socks-2.2.1.tgz", - "integrity": "sha512-0GabKw7n9mI46vcNrVfs0o6XzWzjVa3h6GaSo2UPxtWAROXUWavfJWh1M4PR5tnE0dcnQXZIDFP4yrAysLze/w==", - "dev": true, - "optional": true, - "requires": { - "ip": "1.1.5", - "smart-buffer": "4.0.1" - } - } - } - }, "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", @@ -3952,11 +2557,11 @@ "integrity": "sha512-MjqsvNwyz1s0k81Goz/9vRBe9SZdB09Bdw+/zYyO+3CuPk6fouTaxscHkgtE8jKvf01kVfl8riHzERQ/kefaSA==", "dev": true, "requires": { - "atob": "2.1.1", - "decode-uri-component": "0.2.0", - "resolve-url": "0.2.1", - "source-map-url": "0.4.0", - "urix": "0.1.0" + "atob": "^2.1.1", + "decode-uri-component": "^0.2.0", + "resolve-url": "^0.2.1", + "source-map-url": "^0.4.0", + "urix": "^0.1.0" } }, "source-map-url": { @@ -3971,25 +2576,7 @@ "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==", "dev": true, "requires": { - "extend-shallow": "3.0.2" - } - }, - "sshpk": { - "version": "1.14.2", - "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.14.2.tgz", - "integrity": "sha1-xvxhZIo9nE52T9P8306hBeSSupg=", - "dev": true, - "optional": true, - "requires": { - "asn1": "0.2.3", - "assert-plus": "1.0.0", - "bcrypt-pbkdf": "1.0.2", - "dashdash": "1.14.1", - "ecc-jsbn": "0.1.1", - "getpass": "0.1.7", - "jsbn": "0.1.1", - "safer-buffer": "2.1.2", - "tweetnacl": "0.14.5" + "extend-shallow": "^3.0.0" } }, "static-extend": { @@ -3998,8 +2585,8 @@ "integrity": "sha1-YICcOcv/VTNyJv1eC1IPNB8ftcY=", "dev": true, "requires": { - "define-property": "0.2.5", - "object-copy": "0.1.0" + "define-property": "^0.2.5", + "object-copy": "^0.1.0" }, "dependencies": { "define-property": { @@ -4008,7 +2595,7 @@ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, "requires": { - "is-descriptor": "0.1.6" + "is-descriptor": "^0.1.0" } } } @@ -4025,10 +2612,10 @@ "integrity": "sha512-WREzfy0r0zUqp3lGO096wRuUp7ho1X6uo/7DJfTlEi0Iv/4gT7YHqXDjKC2ioVGBZtE8QzsQD9nx1nIuoZ57jQ==", "dev": true, "requires": { - "date-format": "1.2.0", - "debug": "3.1.0", - "mkdirp": "0.5.1", - "readable-stream": "2.3.6" + "date-format": "^1.2.0", + "debug": "^3.1.0", + "mkdirp": "^0.5.1", + "readable-stream": "^2.3.0" }, "dependencies": { "debug": { @@ -4048,54 +2635,16 @@ "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", "dev": true, "requires": { - "safe-buffer": "5.1.2" + "safe-buffer": "~5.1.0" } }, - "stringstream": { - "version": "0.0.6", - "resolved": "https://registry.npmjs.org/stringstream/-/stringstream-0.0.6.tgz", - "integrity": "sha512-87GEBAkegbBcweToUrdzf3eLhWNg06FJTebl4BVJz/JgWy8CvEr9dRtX5qWphiynMSQlxxi+QqN0z5T32SLlhA==", - "dev": true, - "optional": true - }, - "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", - "dev": true, - "optional": true, - "requires": { - "ansi-regex": "2.1.1" - } - }, - "supports-color": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz", - "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc=", - "dev": true, - "optional": true - }, - "thunkify": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/thunkify/-/thunkify-2.1.2.tgz", - "integrity": "sha1-+qDp0jDFGsyVyhOjYawFyn4EVT0=", - "dev": true, - "optional": true - }, - "timespan": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/timespan/-/timespan-2.3.0.tgz", - "integrity": "sha1-SQLOBAvRPYRcj1myfp1ZutbzmSk=", - "dev": true, - "optional": true - }, "tmp": { "version": "0.0.33", "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", "dev": true, "requires": { - "os-tmpdir": "1.0.2" + "os-tmpdir": "~1.0.2" } }, "to-array": { @@ -4110,7 +2659,7 @@ "integrity": "sha1-KXWIt7Dn4KwI4E5nL4XB9JmeF68=", "dev": true, "requires": { - "kind-of": "3.2.2" + "kind-of": "^3.0.2" }, "dependencies": { "kind-of": { @@ -4119,7 +2668,7 @@ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", "dev": true, "requires": { - "is-buffer": "1.1.6" + "is-buffer": "^1.1.5" } } } @@ -4130,10 +2679,10 @@ "integrity": "sha512-FWtleNAtZ/Ki2qtqej2CXTOayOH9bHDQF+Q48VpWyDXjbYxA4Yz8iDB31zXOBUlOHHKidDbqGVrTUvQMPmBGBw==", "dev": true, "requires": { - "define-property": "2.0.2", - "extend-shallow": "3.0.2", - "regex-not": "1.0.2", - "safe-regex": "1.1.0" + "define-property": "^2.0.2", + "extend-shallow": "^3.0.2", + "regex-not": "^1.0.2", + "safe-regex": "^1.1.0" } }, "to-regex-range": { @@ -4142,51 +2691,8 @@ "integrity": "sha1-fIDBe53+vlmeJzZ+DU3VWQFB2zg=", "dev": true, "requires": { - "is-number": "3.0.0", - "repeat-string": "1.6.1" - } - }, - "tough-cookie": { - "version": "2.3.4", - "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.3.4.tgz", - "integrity": "sha512-TZ6TTfI5NtZnuyy/Kecv+CnoROnyXn2DN97LontgQpCwsX2XyLYCC0ENhYkehSOwAp8rTQKc/NUIF7BkQ5rKLA==", - "dev": true, - "optional": true, - "requires": { - "punycode": "1.4.1" - } - }, - "tsscmp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/tsscmp/-/tsscmp-1.0.5.tgz", - "integrity": "sha1-fcSjOvcVgatDN9qR2FylQn69mpc=", - "dev": true, - "optional": true - }, - "tunnel-agent": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", - "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", - "dev": true, - "optional": true, - "requires": { - "safe-buffer": "5.1.2" - } - }, - "tweetnacl": { - "version": "0.14.5", - "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", - "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=", - "dev": true, - "optional": true - }, - "type-check": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", - "integrity": "sha1-WITKtRLPHTVeP7eE8wgEsrUg23I=", - "dev": true, - "requires": { - "prelude-ls": "1.1.2" + "is-number": "^3.0.0", + "repeat-string": "^1.6.1" } }, "type-is": { @@ -4196,7 +2702,7 @@ "dev": true, "requires": { "media-typer": "0.3.0", - "mime-types": "2.1.19" + "mime-types": "~2.1.18" } }, "ultron": { @@ -4205,22 +2711,16 @@ "integrity": "sha512-UIEXBNeYmKptWH6z8ZnqTeS8fV74zG0/eRU9VGkpzz+LIJNs8W/zM/L+7ctCkRrgbNnnR0xxw4bKOr0cW0N0Og==", "dev": true }, - "underscore": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.7.0.tgz", - "integrity": "sha1-a7rwh3UA02vjTsqlhODbn+8DUgk=", - "dev": true - }, "union-value": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.0.tgz", "integrity": "sha1-XHHDTLW61dzr4+oM0IIHulqhrqQ=", "dev": true, "requires": { - "arr-union": "3.1.0", - "get-value": "2.0.6", - "is-extendable": "0.1.1", - "set-value": "0.4.3" + "arr-union": "^3.1.0", + "get-value": "^2.0.6", + "is-extendable": "^0.1.1", + "set-value": "^0.4.3" }, "dependencies": { "extend-shallow": { @@ -4229,7 +2729,7 @@ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, "requires": { - "is-extendable": "0.1.1" + "is-extendable": "^0.1.0" } }, "set-value": { @@ -4238,10 +2738,10 @@ "integrity": "sha1-fbCPnT0i3H945Trzw79GZuzfzPE=", "dev": true, "requires": { - "extend-shallow": "2.0.1", - "is-extendable": "0.1.1", - "is-plain-object": "2.0.4", - "to-object-path": "0.3.0" + "extend-shallow": "^2.0.1", + "is-extendable": "^0.1.1", + "is-plain-object": "^2.0.1", + "to-object-path": "^0.3.0" } } } @@ -4258,8 +2758,8 @@ "integrity": "sha1-g3aHP30jNRef+x5vw6jtDfyKtVk=", "dev": true, "requires": { - "has-value": "0.3.1", - "isobject": "3.0.1" + "has-value": "^0.3.1", + "isobject": "^3.0.0" }, "dependencies": { "has-value": { @@ -4268,9 +2768,9 @@ "integrity": "sha1-ex9YutpiyoJ+wKIHgCVlSEWZXh8=", "dev": true, "requires": { - "get-value": "2.0.6", - "has-values": "0.1.4", - "isobject": "2.1.0" + "get-value": "^2.0.3", + "has-values": "^0.1.4", + "isobject": "^2.0.0" }, "dependencies": { "isobject": { @@ -4316,16 +2816,8 @@ "integrity": "sha1-z1k+9PLRdYdei7ZY6pLhik/QbY4=", "dev": true, "requires": { - "lru-cache": "2.2.4", - "tmp": "0.0.33" - }, - "dependencies": { - "lru-cache": { - "version": "2.2.4", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-2.2.4.tgz", - "integrity": "sha1-bGWGGb7PFAMdDQtZSxYELOTcBj0=", - "dev": true - } + "lru-cache": "2.2.x", + "tmp": "0.0.x" } }, "util-deprecate": { @@ -4340,67 +2832,26 @@ "integrity": "sha1-n5VxD1CiZ5R7LMwSR0HBAoQn5xM=", "dev": true }, - "uuid": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.2.tgz", - "integrity": "sha512-yXJmeNaw3DnnKAOKJE51sL/ZaYfWJRl1pK9dr19YFCu0ObS231AB1/LbqTKRAQ5kw8A90rA6fr4riOUpTZvQZA==", - "dev": true, - "optional": true - }, - "uws": { - "version": "9.14.0", - "resolved": "https://registry.npmjs.org/uws/-/uws-9.14.0.tgz", - "integrity": "sha512-HNMztPP5A1sKuVFmdZ6BPVpBQd5bUjNC8EFMFiICK+oho/OQsAJy5hnIx4btMHiOk8j04f/DbIlqnEZ9d72dqg==", - "dev": true, - "optional": true - }, - "verror": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", - "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", - "dev": true, - "optional": true, - "requires": { - "assert-plus": "1.0.0", - "core-util-is": "1.0.2", - "extsprintf": "1.3.0" - } - }, "void-elements": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/void-elements/-/void-elements-2.0.1.tgz", "integrity": "sha1-wGavtYK7HLQSjWDqkjkulNXp2+w=", "dev": true }, - "when": { - "version": "3.7.8", - "resolved": "https://registry.npmjs.org/when/-/when-3.7.8.tgz", - "integrity": "sha1-xxMLan6gRpPoQs3J56Hyqjmjn4I=", - "dev": true, - "optional": true - }, "which": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", "dev": true, "requires": { - "isexe": "2.0.0" + "isexe": "^2.0.0" } }, - "with-callback": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/with-callback/-/with-callback-1.0.2.tgz", - "integrity": "sha1-oJYpuakgAo1yFAT7Q1vc/1yRvCE=", - "dev": true, - "optional": true - }, "wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", - "dev": true, - "optional": true + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz", + "integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=", + "dev": true }, "wrappy": { "version": "1.0.2", @@ -4414,9 +2865,9 @@ "integrity": "sha512-nnWLa/NwZSt4KQJu51MYlCcSQ5g7INpOrOMt4XV8j4dqTXdmlUmSHQ8/oLC069ckre0fRsgfvsKwbTdtKLCDkA==", "dev": true, "requires": { - "async-limiter": "1.0.0", - "safe-buffer": "5.1.2", - "ultron": "1.1.1" + "async-limiter": "~1.0.0", + "safe-buffer": "~5.1.0", + "ultron": "~1.1.0" } }, "xmlhttprequest-ssl": { @@ -4425,27 +2876,6 @@ "integrity": "sha1-wodrBhaKrcQOV9l+gRkayPQ5iz4=", "dev": true }, - "xregexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/xregexp/-/xregexp-2.0.0.tgz", - "integrity": "sha1-UqY+VsoLhKfzpfPWGHLxJq16WUM=", - "dev": true, - "optional": true - }, - "xtend": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz", - "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68=", - "dev": true, - "optional": true - }, - "yallist": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", - "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=", - "dev": true, - "optional": true - }, "yeast": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/yeast/-/yeast-0.1.2.tgz", diff --git a/package.json b/package.json index 8e7d36d2c..8f281ec49 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ }, "devDependencies": { "jasmine-core": "^3.1.0", - "karma": "^2.0.4", + "karma": "^3.0.0", "karma-chrome-launcher": "^2.2.0", "karma-firefox-launcher": "^1.1.0", "karma-jasmine": "^1.1.2" From 97164faec3a641c406217c971df6a3948758b29d Mon Sep 17 00:00:00 2001 From: Ashley Whetter Date: Mon, 13 Aug 2018 15:33:49 -0700 Subject: [PATCH 128/174] Plugins can resolve imported members for viewcode --- doc/usage/extensions/viewcode.rst | 16 +++++++++++++++- sphinx/ext/viewcode.py | 8 +++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/doc/usage/extensions/viewcode.rst b/doc/usage/extensions/viewcode.rst index ea7d5d335..cc7dbb07a 100644 --- a/doc/usage/extensions/viewcode.rst +++ b/doc/usage/extensions/viewcode.rst @@ -25,7 +25,11 @@ from the source to the description will also be inserted. In addition, if you don't want to import the modules by ``viewcode``, you can tell the location of the location of source code to ``viewcode`` - using :event:`viewcode-find-source` event. + using the :event:`viewcode-find-source` event. + + If :confval:`viewcode_follow_imported_members` is enabled, + you will also need to resolve imported attributes + using the :event:`viewcode-follow-imported` event. This extension works only on HTML related builders like ``html``, ``applehelp``, ``devhelp``, ``htmlhelp``, ``qthelp`` and so on except @@ -83,3 +87,13 @@ Configuration :param app: The Sphinx application object. :param modname: The name of the module to find source code for. + +.. event:: viewcode-follow-imported (app, modname, attribute) + + .. versionadded:: 1.8 + + Find the name of the original module for an attribute. + + :param app: The Sphinx application object. + :param modname: The name of the module that the attribute belongs to. + :param attribute: The name of the member to follow. diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 6d3c3c1c0..ca944a636 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -104,7 +104,12 @@ def doctree_read(app, doctree): fullname = signode.get('fullname') refname = modname if env.config.viewcode_follow_imported_members: - modname = _get_full_modname(app, modname, fullname) + new_modname = app.emit_firstresult( + 'viewcode-follow-imported', modname, fullname, + ) + if not new_modname: + new_modname = _get_full_modname(app, modname, fullname) + modname = new_modname if not modname: continue fullname = signode.get('fullname') @@ -262,6 +267,7 @@ def setup(app): # app.add_config_value('viewcode_include_modules', [], 'env') # app.add_config_value('viewcode_exclude_modules', [], 'env') app.add_event('viewcode-find-source') + app.add_event('viewcode-follow-imported') return { 'version': sphinx.__display_version__, 'env_version': 1, From 0680805cc3f2b805452f590f374ac1161eb87259 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Tue, 14 Aug 2018 14:30:22 +0800 Subject: [PATCH 129/174] add a new book "SpotBugs manual" to EXAMPLES --- EXAMPLES | 2 ++ 1 file changed, 2 insertions(+) diff --git a/EXAMPLES b/EXAMPLES index 34e063dc6..b9102b8f3 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -362,6 +362,7 @@ Documentation using sphinx_rtd_theme * `Sphinx AutoAPI`__ * `sphinx-argparse`__ * `Sphinx-Gallery`__ (customized) +* `SpotBugs`__ * `StarUML`__ * `Sublime Text Unofficial Documentation`__ * `SunPy`__ @@ -460,6 +461,7 @@ __ http://docs.python-soco.com/ __ https://sphinx-autoapi.readthedocs.io/ __ https://sphinx-argparse.readthedocs.io/ __ https://sphinx-gallery.readthedocs.io/ +__ https://spotbugs.readthedocs.io/ __ http://docs.staruml.io/ __ http://docs.sublimetext.info/ __ http://docs.sunpy.org/ From e26dc81272b1645fe87a70b68153a77cfd06bb2f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Aug 2018 00:32:14 +0900 Subject: [PATCH 130/174] Fix autodoc: Optional types are wrongly rendered --- CHANGES | 1 + sphinx/util/inspect.py | 85 +++++++++++++++++++++++--------------- tests/test_util_inspect.py | 7 +++- tests/typing_test_data.py | 6 ++- 4 files changed, 63 insertions(+), 36 deletions(-) diff --git a/CHANGES b/CHANGES index 4881ce3c4..2cdb52a6c 100644 --- a/CHANGES +++ b/CHANGES @@ -27,6 +27,7 @@ Bugs fixed * LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern font with XeLaTeX/LuaLateX (refs: #5251) * #5280: autodoc: Fix wrong type annotations for complex typing +* autodoc: Optional types are wrongly rendered Testing -------- diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 7dbf742b4..2c72af7a0 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -486,8 +486,11 @@ class Signature(object): if getattr(annotation, '__args__', None): if qualname == 'Union': - args = ', '.join(self.format_annotation(a) for a in annotation.__args__) - return '%s[%s]' % (qualname, args) + if len(annotation.__args__) == 2 and annotation.__args__[1] is NoneType: + return 'Optional[%s]' % self.format_annotation(annotation.__args__[0]) + else: + args = ', '.join(self.format_annotation(a) for a in annotation.__args__) + return '%s[%s]' % (qualname, args) elif qualname == 'Callable': args = ', '.join(self.format_annotation(a) for a in annotation.__args__[:-1]) returns = self.format_annotation(annotation.__args__[-1]) @@ -501,38 +504,39 @@ class Signature(object): def format_annotation_old(self, annotation): # type: (Any) -> str """format_annotation() for py36 or below""" + module = getattr(annotation, '__module__', None) if isinstance(annotation, string_types): return annotation # type: ignore - if isinstance(annotation, typing.TypeVar): # type: ignore + elif isinstance(annotation, typing.TypeVar): # type: ignore return annotation.__name__ - if annotation == Ellipsis: - return '...' - if not isinstance(annotation, type): - qualified_name = repr(annotation) - if qualified_name.startswith('typing.'): # for typing.Union - return qualified_name.split('.', 1)[1] - else: - return qualified_name - - if not annotation: - qualified_name = repr(annotation) - elif annotation.__module__ == 'typing': - qualified_name = annotation.__qualname__ # type: ignore - else: - qualified_name = (annotation.__module__ + '.' + annotation.__qualname__) # type: ignore # NOQA - - if annotation is NoneType: # type: ignore + elif not annotation: + return repr(annotation) + elif annotation is NoneType: # type: ignore return 'None' + elif module == 'builtins': + return annotation.__qualname__ + elif annotation is Ellipsis: + return '...' - if annotation.__module__ == 'builtins': - return annotation.__qualname__ # type: ignore - elif (hasattr(typing, 'TupleMeta') and - isinstance(annotation, typing.TupleMeta) and # type: ignore - not hasattr(annotation, '__tuple_params__')): + if module == 'typing': + if getattr(annotation, '_name', None): + qualname = annotation._name + elif getattr(annotation, '__qualname__', None): + qualname = annotation.__qualname__ + else: + qualname = self.format_annotation(annotation.__origin__) # ex. Union + elif hasattr(annotation, '__qualname__'): + qualname = '%s.%s' % (module, annotation.__qualname__) + else: + qualname = repr(annotation) + + if (hasattr(typing, 'TupleMeta') and + isinstance(annotation, typing.TupleMeta) and # type: ignore + not hasattr(annotation, '__tuple_params__')): # This is for Python 3.6+, 3.5 case is handled below params = annotation.__args__ param_str = ', '.join(self.format_annotation(p) for p in params) - return '%s[%s]' % (qualified_name, param_str) + return '%s[%s]' % (qualname, param_str) elif (hasattr(typing, 'GenericMeta') and # for py36 or below isinstance(annotation, typing.GenericMeta)): # In Python 3.5.2+, all arguments are stored in __args__, @@ -548,19 +552,32 @@ class Signature(object): args = ', '.join(self.format_annotation(arg) for arg in annotation.__args__[:-1]) # type: ignore result = self.format_annotation(annotation.__args__[-1]) # type: ignore - return '%s[[%s], %s]' % (qualified_name, args, result) + return '%s[[%s], %s]' % (qualname, args, result) elif hasattr(annotation, '__parameters__'): params = annotation.__parameters__ # type: ignore if params is not None: param_str = ', '.join(self.format_annotation(p) for p in params) - return '%s[%s]' % (qualified_name, param_str) + return '%s[%s]' % (qualname, param_str) elif (hasattr(typing, 'UnionMeta') and # for py35 or below isinstance(annotation, typing.UnionMeta) and # type: ignore hasattr(annotation, '__union_params__')): params = annotation.__union_params__ if params is not None: - param_str = ', '.join(self.format_annotation(p) for p in params) - return '%s[%s]' % (qualified_name, param_str) + if len(params) == 2 and params[1] is NoneType: + return 'Optional[%s]' % self.format_annotation(params[0]) + else: + param_str = ', '.join(self.format_annotation(p) for p in params) + return '%s[%s]' % (qualname, param_str) + elif (hasattr(typing, 'Union') and # for py36 + hasattr(annotation, '__origin__') and + annotation.__origin__ is typing.Union): + params = annotation.__args__ + if params is not None: + if len(params) == 2 and params[1] is NoneType: + return 'Optional[%s]' % self.format_annotation(params[0]) + else: + param_str = ', '.join(self.format_annotation(p) for p in params) + return 'Union[%s]' % param_str elif (hasattr(typing, 'CallableMeta') and # for py36 or below isinstance(annotation, typing.CallableMeta) and # type: ignore getattr(annotation, '__args__', None) is not None and @@ -568,13 +585,13 @@ class Signature(object): # Skipped in the case of plain typing.Callable args = annotation.__args__ if args is None: - return qualified_name + return qualname elif args is Ellipsis: args_str = '...' else: formatted_args = (self.format_annotation(a) for a in args) args_str = '[%s]' % ', '.join(formatted_args) - return '%s[%s, %s]' % (qualified_name, + return '%s[%s, %s]' % (qualname, args_str, self.format_annotation(annotation.__result__)) elif (hasattr(typing, 'TupleMeta') and # for py36 or below @@ -586,10 +603,10 @@ class Signature(object): param_strings = [self.format_annotation(p) for p in params] if annotation.__tuple_use_ellipsis__: param_strings.append('...') - return '%s[%s]' % (qualified_name, + return '%s[%s]' % (qualname, ', '.join(param_strings)) - return qualified_name + return qualname if sys.version_info >= (3, 5): diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 2b6e0abb2..61a8308e5 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -232,7 +232,7 @@ def test_Signature_partialmethod(): reason='type annotation test is available on py35 or above') def test_Signature_annotations(): from typing_test_data import ( - f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, Node) + f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, Node) # Class annotations sig = inspect.Signature(f0).format_args() @@ -289,6 +289,11 @@ def test_Signature_annotations(): sig = inspect.Signature(f12).format_args() assert sig == '() -> Tuple[int, str, int]' + # optional + sig = inspect.Signature(f13).format_args() + assert sig == '() -> Optional[str]' + + # type hints by string sig = inspect.Signature(Node.children).format_args() assert sig == '(self) -> List[typing_test_data.Node]' diff --git a/tests/typing_test_data.py b/tests/typing_test_data.py index 7ad90551d..35064b042 100644 --- a/tests/typing_test_data.py +++ b/tests/typing_test_data.py @@ -1,5 +1,5 @@ from numbers import Integral -from typing import List, TypeVar, Union, Callable, Tuple +from typing import List, TypeVar, Union, Callable, Tuple, Optional def f0(x: int, y: Integral) -> None: @@ -68,6 +68,10 @@ def f12() -> Tuple[int, str, int]: pass +def f13() -> Optional[str]: + pass + + class Node: def children(self) -> List['Node']: pass From 5a0f0bdc61ef72b7635ab2eff125e6dcd82191f3 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Aug 2018 00:42:25 +0900 Subject: [PATCH 131/174] refactor: format_annotation() --- sphinx/util/inspect.py | 39 +++++++++++++-------------------------- 1 file changed, 13 insertions(+), 26 deletions(-) diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 2c72af7a0..2de9ca294 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -450,6 +450,19 @@ class Signature(object): Displaying complex types from ``typing`` relies on its private API. """ + if isinstance(annotation, string_types): + return annotation # type: ignore + elif isinstance(annotation, typing.TypeVar): # type: ignore + return annotation.__name__ + elif not annotation: + return repr(annotation) + elif annotation is NoneType: # type: ignore + return 'None' + elif getattr(annotation, '__module__', None) == 'builtins': + return annotation.__qualname__ + elif annotation is Ellipsis: + return '...' + if sys.version_info >= (3, 7): # py37+ return self.format_annotation_new(annotation) else: @@ -459,19 +472,6 @@ class Signature(object): # type: (Any) -> str """format_annotation() for py37+""" module = getattr(annotation, '__module__', None) - if isinstance(annotation, string_types): - return annotation # type: ignore - elif isinstance(annotation, typing.TypeVar): # type: ignore - return annotation.__name__ - elif not annotation: - return repr(annotation) - elif annotation is NoneType: # type: ignore - return 'None' - elif module == 'builtins': - return annotation.__qualname__ - elif annotation is Ellipsis: - return '...' - if module == 'typing': if getattr(annotation, '_name', None): qualname = annotation._name @@ -505,19 +505,6 @@ class Signature(object): # type: (Any) -> str """format_annotation() for py36 or below""" module = getattr(annotation, '__module__', None) - if isinstance(annotation, string_types): - return annotation # type: ignore - elif isinstance(annotation, typing.TypeVar): # type: ignore - return annotation.__name__ - elif not annotation: - return repr(annotation) - elif annotation is NoneType: # type: ignore - return 'None' - elif module == 'builtins': - return annotation.__qualname__ - elif annotation is Ellipsis: - return '...' - if module == 'typing': if getattr(annotation, '_name', None): qualname = annotation._name From 955c3d388be01600aad6043c609c5fda01d96ebf Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Aug 2018 00:48:28 +0900 Subject: [PATCH 132/174] test Signature annotations in py34 too --- tests/test_util_inspect.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 61a8308e5..51c2d06e1 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -228,8 +228,8 @@ def test_Signature_partialmethod(): assert sig == '()' -@pytest.mark.skipif(sys.version_info < (3, 5), - reason='type annotation test is available on py35 or above') +@pytest.mark.skipif(sys.version_info < (3, 4), + reason='type annotation test is available on py34 or above') def test_Signature_annotations(): from typing_test_data import ( f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, Node) From cc3de81debdecb62cfb8cc182e4dd5e5002d2396 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Aug 2018 11:39:54 +0900 Subject: [PATCH 133/174] Fix mypy annotations --- sphinx/util/inspect.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 2de9ca294..c3fe0178d 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -486,7 +486,7 @@ class Signature(object): if getattr(annotation, '__args__', None): if qualname == 'Union': - if len(annotation.__args__) == 2 and annotation.__args__[1] is NoneType: + if len(annotation.__args__) == 2 and annotation.__args__[1] is NoneType: # type: ignore # NOQA return 'Optional[%s]' % self.format_annotation(annotation.__args__[0]) else: args = ', '.join(self.format_annotation(a) for a in annotation.__args__) @@ -550,7 +550,7 @@ class Signature(object): hasattr(annotation, '__union_params__')): params = annotation.__union_params__ if params is not None: - if len(params) == 2 and params[1] is NoneType: + if len(params) == 2 and params[1] is NoneType: # type: ignore return 'Optional[%s]' % self.format_annotation(params[0]) else: param_str = ', '.join(self.format_annotation(p) for p in params) @@ -560,7 +560,7 @@ class Signature(object): annotation.__origin__ is typing.Union): params = annotation.__args__ if params is not None: - if len(params) == 2 and params[1] is NoneType: + if len(params) == 2 and params[1] is NoneType: # type: ignore return 'Optional[%s]' % self.format_annotation(params[0]) else: param_str = ', '.join(self.format_annotation(p) for p in params) From 6433e08069d644c96dfe846a18e273688b6897f7 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Wed, 15 Aug 2018 10:08:31 +0200 Subject: [PATCH 134/174] C++, add parsing of delete expressions. --- CHANGES | 1 + sphinx/domains/cpp.py | 57 +++++++++++++++++++++++++++++++++++++--- tests/test_domain_cpp.py | 5 ++++ 3 files changed, 60 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index ca6e9d5be..13ff43b19 100644 --- a/CHANGES +++ b/CHANGES @@ -213,6 +213,7 @@ Bugs fixed * #5191: C++, prevent nested declarations in functions to avoid lookup problems. * #5126: C++, add missing isPack method for certain template parameter types. * #5187: C++, parse attributes on declerators as well. +* C++, parse delete expressions as well. * #5002: graphviz: SVGs do not adapt to the column width Testing diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 598386c7b..837b6390c 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1106,6 +1106,38 @@ class ASTNoexceptExpr(ASTBase): signode.append(nodes.Text(')')) +class ASTDeleteExpr(ASTBase): + def __init__(self, rooted, array, expr): + self.rooted = rooted + self.array = array + self.expr = expr + + def _stringify(self, transform): + res = [] + if self.rooted: + res.append('::') + res.append('delete ') + if self.array: + res.append('[] ') + res.append(transform(self.expr)) + return u''.join(res) + + def get_id(self, version): + if self.array: + id = "da" + else: + id = "dl" + return id + self.expr.get_id(version) + + def describe_signature(self, signode, mode, env, symbol): + if self.rooted: + signode.append(nodes.Text('::')) + signode.append(nodes.Text('delete ')) + if self.array: + signode.append(nodes.Text('[] ')) + self.expr.describe_signature(signode, mode, env, symbol) + + class ASTExplicitCast(ASTBase): def __init__(self, cast, typ, expr): assert cast in _id_explicit_cast @@ -4571,7 +4603,26 @@ class DefinitionParser(object): if not self.skip_string(')'): self.fail("Expecting ')' to end 'noexcept'.") return ASTNoexceptExpr(expr) - # TODO: the rest + # new-expression + pos = self.pos + rooted = self.skip_string('::') + self.skip_ws() + if not self.skip_word_and_ws('new'): + self.pos = pos + else: + self.fail("Sorry, new-expressions not yet supported.") + # delete-expression + pos = self.pos + rooted = self.skip_string('::') + self.skip_ws() + if not self.skip_word_and_ws('delete'): + self.pos = pos + else: + array = self.skip_string_and_ws('[') + if array and not self.skip_string_and_ws(']'): + self.fail("Expected ']' in array delete-expression.") + expr = self._parse_cast_expression() + return ASTDeleteExpr(rooted, array, expr) return self._parse_postfix_expression() def _parse_cast_expression(self): @@ -5776,8 +5827,8 @@ class DefinitionParser(object): except DefinitionError as exType: header = "Error when parsing (type) expression." errs = [] - errs.append((exExpr, "If expression:")) - errs.append((exType, "If type:")) + errs.append((exExpr, "If expression")) + errs.append((exType, "If type")) raise self._make_multi_error(errs, header) return expr diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 89c37aa3c..e26da217e 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -171,6 +171,11 @@ def test_expressions(): exprCheck('sizeof -42', 'szngL42E') exprCheck('alignof(T)', 'at1T') exprCheck('noexcept(-42)', 'nxngL42E') + # TODO: new-expression + exprCheck('delete p', 'dl1p') + exprCheck('delete [] p', 'da1p') + exprCheck('::delete p', 'dl1p') + exprCheck('::delete [] p', 'da1p') # cast exprCheck('(int)2', 'cviL2E') # binary op From 91650d89c9bb53c78e22eb94a31edc5656faa0b5 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Aug 2018 01:42:07 +0900 Subject: [PATCH 135/174] Fix #5291: autodoc crashed by ForwardRef types --- CHANGES | 2 ++ sphinx/util/inspect.py | 4 ++++ tests/test_util_inspect.py | 3 +++ tests/typing_test_data.py | 3 +++ 4 files changed, 12 insertions(+) diff --git a/CHANGES b/CHANGES index 2cdb52a6c..7472232da 100644 --- a/CHANGES +++ b/CHANGES @@ -28,6 +28,8 @@ Bugs fixed font with XeLaTeX/LuaLateX (refs: #5251) * #5280: autodoc: Fix wrong type annotations for complex typing * autodoc: Optional types are wrongly rendered +* #5291: autodoc crashed by ForwardRef types + Testing -------- diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index c3fe0178d..64e93f267 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -477,6 +477,8 @@ class Signature(object): qualname = annotation._name elif getattr(annotation, '__qualname__', None): qualname = annotation.__qualname__ + elif getattr(annotation, '__forward_arg__', None): + qualname = annotation.__forward_arg__ else: qualname = self.format_annotation(annotation.__origin__) # ex. Union elif hasattr(annotation, '__qualname__'): @@ -510,6 +512,8 @@ class Signature(object): qualname = annotation._name elif getattr(annotation, '__qualname__', None): qualname = annotation.__qualname__ + elif getattr(annotation, '__forward_arg__', None): + qualname = annotation.__forward_arg__ else: qualname = self.format_annotation(annotation.__origin__) # ex. Union elif hasattr(annotation, '__qualname__'): diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 51c2d06e1..a48aedcf0 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -297,6 +297,9 @@ def test_Signature_annotations(): sig = inspect.Signature(Node.children).format_args() assert sig == '(self) -> List[typing_test_data.Node]' + sig = inspect.Signature(Node.__init__).format_args() + assert sig == '(self, parent: Optional[Node]) -> None' + def test_safe_getattr_with_default(): class Foo(object): diff --git a/tests/typing_test_data.py b/tests/typing_test_data.py index 35064b042..5b161eac4 100644 --- a/tests/typing_test_data.py +++ b/tests/typing_test_data.py @@ -73,5 +73,8 @@ def f13() -> Optional[str]: class Node: + def __init__(self, parent: Optional['Node']) -> None: + pass + def children(self) -> List['Node']: pass From 1668f007c299871a0699b58e6b3475cdf4c243a3 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 15 Aug 2018 22:29:29 +0900 Subject: [PATCH 136/174] Fix #5298: imgmath: math_number_all causes equations to have two numbers in html --- CHANGES | 1 + sphinx/ext/imgmath.py | 3 +-- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index 2cdb52a6c..66493877d 100644 --- a/CHANGES +++ b/CHANGES @@ -28,6 +28,7 @@ Bugs fixed font with XeLaTeX/LuaLateX (refs: #5251) * #5280: autodoc: Fix wrong type annotations for complex typing * autodoc: Optional types are wrongly rendered +* #5298: imgmath: math_number_all causes equations to have two numbers in html Testing -------- diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index 5f9d7a1e2..cfec4db28 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -319,8 +319,7 @@ def html_visit_displaymath(self, node): if node['nowrap']: latex = node['latex'] else: - latex = wrap_displaymath(node['latex'], None, - self.builder.config.math_number_all) + latex = wrap_displaymath(node['latex'], None, False) try: fname, depth = render_math(self, latex) except MathExtError as exc: From 9185c2c356afd3b829956513dc2e9cbbe7b44c46 Mon Sep 17 00:00:00 2001 From: Antti Kaihola Date: Thu, 16 Aug 2018 13:22:59 +0300 Subject: [PATCH 137/174] Ref #5273: doctest: add tests for the :skipif: option --- tests/roots/test-ext-doctest-skipif/conf.py | 10 +++ .../roots/test-ext-doctest-skipif/skipif.txt | 81 +++++++++++++++++++ tests/test_ext_doctest.py | 45 +++++++++++ 3 files changed, 136 insertions(+) create mode 100644 tests/roots/test-ext-doctest-skipif/conf.py create mode 100644 tests/roots/test-ext-doctest-skipif/skipif.txt diff --git a/tests/roots/test-ext-doctest-skipif/conf.py b/tests/roots/test-ext-doctest-skipif/conf.py new file mode 100644 index 000000000..5f3e89786 --- /dev/null +++ b/tests/roots/test-ext-doctest-skipif/conf.py @@ -0,0 +1,10 @@ +extensions = ['sphinx.ext.doctest'] + +project = 'test project for the doctest :skipif: directive' +master_doc = 'skipif' +source_suffix = '.txt' +exclude_patterns = ['_build'] + +doctest_global_setup = ''' +from test_ext_doctest import record +''' \ No newline at end of file diff --git a/tests/roots/test-ext-doctest-skipif/skipif.txt b/tests/roots/test-ext-doctest-skipif/skipif.txt new file mode 100644 index 000000000..c5bd39821 --- /dev/null +++ b/tests/roots/test-ext-doctest-skipif/skipif.txt @@ -0,0 +1,81 @@ +Testing the doctest extension's `:skipif:` option +================================================= + +testsetup +--------- + +.. testsetup:: group-skipif + :skipif: record('testsetup', ':skipif:', True) != 'this will be True' + + record('testsetup', 'body', True) + +.. testsetup:: group-skipif + :skipif: record('testsetup', ':skipif:', False) == 'this will be False' + + record('testsetup', 'body', False) + + +doctest +------- +.. doctest:: group-skipif + :skipif: record('doctest', ':skipif:', True) != 'this will be True' + + >>> print(record('doctest', 'body', True)) + The test is skipped, and this expected text is ignored + + +.. doctest:: + :skipif: record('doctest', ':skipif:', False) == 'this will be False' + + >>> print(record('doctest', 'body', False)) + Recorded doctest body False + + +testcode and testoutput +----------------------- + +testcode skipped +~~~~~~~~~~~~~~~~ + +.. testcode:: group-skipif + :skipif: record('testcode', ':skipif:', True) != 'this will be True' + + print(record('testcode', 'body', True)) + +.. testoutput:: group-skipif + :skipif: record('testoutput-1', ':skipif:', True) != 'this will be True' + + The previous testcode is skipped, and the :skipif: condition is True, + so this testoutput is ignored + +testcode executed +~~~~~~~~~~~~~~~~~ + +.. testcode:: group-skipif + :skipif: record('testcode', ':skipif:', False) == 'this will be False' + + print(record('testcode', 'body', False)) + +.. testoutput:: group-skipif + :skipif: record('testoutput-2', ':skipif:', False) == 'this will be False' + + Recorded testcode body False + +.. testoutput:: group-skipif + :skipif: record('testoutput-2', ':skipif:', True) != 'this will be True' + + The :skipif: condition is False, so this testoutput is ignored + + +testcleanup +----------- + +.. testcleanup:: group-skipif + :skipif: record('testcleanup', ':skipif:', True) != 'this will be True' + + record('testcleanup', 'body', True) + +.. testcleanup:: group-skipif + :skipif: record('testcleanup', ':skipif:', False) == 'this will be False' + + record('testcleanup', 'body', False) diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index 7137af31b..5ae3c0f7a 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -61,6 +61,51 @@ def cleanup_call(): cleanup_called += 1 +recorded_calls = set() + + +@pytest.mark.sphinx('doctest', testroot='ext-doctest-skipif') +def test_skipif(app, status, warning): + """Tests for the :skipif: option + + The tests are separated into a different test root directory since the + ``app`` object only evaluates options once in its lifetime. If these tests + were combined with the other doctest tests, the ``:skipif:`` evaluations + would be recorded only on the first ``app.builder.build_all()`` run, i.e. + in ``test_build`` above, and the assertion below would fail. + + """ + global recorded_calls + recorded_calls = set() + app.builder.build_all() + if app.statuscode != 0: + assert False, 'failures in doctests:' + status.getvalue() + # The `:skipif:` expressions are always run. + # Actual tests and setup/cleanup code is only run if the `:skipif:` + # expression evaluates to a False value. + assert recorded_calls == {('testsetup', ':skipif:', True), + ('testsetup', ':skipif:', False), + ('testsetup', 'body', False), + ('doctest', ':skipif:', True), + ('doctest', ':skipif:', False), + ('doctest', 'body', False), + ('testcode', ':skipif:', True), + ('testcode', ':skipif:', False), + ('testcode', 'body', False), + ('testoutput-1', ':skipif:', True), + ('testoutput-2', ':skipif:', True), + ('testoutput-2', ':skipif:', False), + ('testcleanup', ':skipif:', True), + ('testcleanup', ':skipif:', False), + ('testcleanup', 'body', False)} + + +def record(directive, part, should_skip): + global recorded_calls + recorded_calls.add((directive, part, should_skip)) + return 'Recorded {} {} {}'.format(directive, part, should_skip) + + @pytest.mark.xfail( PY2, reason='node.source points to document instead of filename', ) From 43d5810083de3a0c5b595ea4f937e792b101dc16 Mon Sep 17 00:00:00 2001 From: Antti Kaihola Date: Thu, 16 Aug 2018 14:01:57 +0300 Subject: [PATCH 138/174] Ref #5273: doctest: add documentation for the :skipif: option --- doc/usage/extensions/doctest.rst | 75 ++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/doc/usage/extensions/doctest.rst b/doc/usage/extensions/doctest.rst index 341b7a9a7..e321e3a54 100644 --- a/doc/usage/extensions/doctest.rst +++ b/doc/usage/extensions/doctest.rst @@ -198,6 +198,81 @@ The following is an example for the usage of the directives. The test via This parrot wouldn't voom if you put 3000 volts through it! +Skipping tests conditionally +---------------------------- + +``skipif``, a string option, can be used to skip directives conditionally. This +may be useful e.g. when a different set of tests should be run depending on the +environment (hardware, network/VPN, optional dependencies or different versions +of dependencies). The ``skipif`` option is supported by all of the doctest +directives. Below are typical use cases for ``skipif`` when used for different +directives: + +- :rst:dir:`testsetup` and :rst:dir:`testcleanup` + + - conditionally skip test setup and/or cleanup + - customize setup/cleanup code per environment + +- :rst:dir:`doctest` + + - conditionally skip both a test and its output verification + +- :rst:dir:`testcode` + + - conditionally skip a test + - customize test code per environment + +- :rst:dir:`testoutput` + + - conditionally skip output assertion for a skipped test + - expect different output depending on the environment + +The value of the ``skipif`` option is evaluated as a Python expression. If the +result is a true value, the directive is omitted from the test run just as if +it wasn't present in the file at all. + +Instead of repeating an expression, the :confval:`doctest_global_setup` +configuration option can be used to assign it to a variable which can then be +used instead. + +Here's an example which skips some tests if Pandas is not installed: + +.. code-block:: py + :caption: conf.py + + extensions = ['sphinx.ext.doctest'] + doctest_global_setup = ''' + try: + import pandas as pd + except ImportError: + pd = None + ''' + +.. code-block:: rst + :caption: contents.rst + + .. testsetup:: + :skipif: pd is None + + data = pd.Series([42]) + + .. doctest:: + :skipif: pd is None + + >>> data.iloc[0] + 42 + + .. testcode:: + :skipif: pd is None + + print(data.iloc[-1]) + + .. testoutput:: + :skipif: pd is None + + 42 + + Configuration ------------- From 5ffc924940a6dfbfef84e02cb07691b5630517e2 Mon Sep 17 00:00:00 2001 From: Antti Kaihola Date: Thu, 16 Aug 2018 14:09:06 +0300 Subject: [PATCH 139/174] Ref #5273: doctest: added a missing final newline --- tests/roots/test-ext-doctest-skipif/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/roots/test-ext-doctest-skipif/conf.py b/tests/roots/test-ext-doctest-skipif/conf.py index 5f3e89786..d6be0585a 100644 --- a/tests/roots/test-ext-doctest-skipif/conf.py +++ b/tests/roots/test-ext-doctest-skipif/conf.py @@ -7,4 +7,4 @@ exclude_patterns = ['_build'] doctest_global_setup = ''' from test_ext_doctest import record -''' \ No newline at end of file +''' From d52488f028a583af0d0c921ef034ebd37b707aa7 Mon Sep 17 00:00:00 2001 From: Antti Kaihola Date: Thu, 16 Aug 2018 14:56:53 +0300 Subject: [PATCH 140/174] Ref #5273: doctest: added a missing type hint --- sphinx/ext/doctest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index bd1352b98..fa6cbed6d 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -92,7 +92,7 @@ class TestDirective(SphinxDirective): # type: () -> List[nodes.Node] if 'skipif' in self.options: condition = self.options['skipif'] - context = {} + context = {} # type: Dict[str, Any] if self.config.doctest_global_setup: exec(self.config.doctest_global_setup, context) should_skip = eval(condition, context) From 098f37fddf2f4239a4387e18d5d78df814faf925 Mon Sep 17 00:00:00 2001 From: Antti Kaihola Date: Thu, 16 Aug 2018 17:56:29 +0300 Subject: [PATCH 141/174] Ref #5273: doctest: add test for skipif calling global setup/cleanup Ensure that `doctest_global_setup` and `doctest_global_cleanup` are executed before and after evaluating each `:skipif:` option. --- tests/roots/test-ext-doctest-skipif/conf.py | 6 +++ tests/test_ext_doctest.py | 42 ++++++++++++--------- 2 files changed, 30 insertions(+), 18 deletions(-) diff --git a/tests/roots/test-ext-doctest-skipif/conf.py b/tests/roots/test-ext-doctest-skipif/conf.py index d6be0585a..dd94b7049 100644 --- a/tests/roots/test-ext-doctest-skipif/conf.py +++ b/tests/roots/test-ext-doctest-skipif/conf.py @@ -7,4 +7,10 @@ exclude_patterns = ['_build'] doctest_global_setup = ''' from test_ext_doctest import record + +record('doctest_global_setup', 'body', True) ''' + +doctest_global_cleanup = ''' +record('doctest_global_cleanup', 'body', True) +''' \ No newline at end of file diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index 5ae3c0f7a..f7b6ca5f8 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -9,6 +9,7 @@ :license: BSD, see LICENSE for details. """ import os +from collections import Counter import pytest from packaging.specifiers import InvalidSpecifier @@ -61,7 +62,7 @@ def cleanup_call(): cleanup_called += 1 -recorded_calls = set() +recorded_calls = Counter() @pytest.mark.sphinx('doctest', testroot='ext-doctest-skipif') @@ -76,33 +77,38 @@ def test_skipif(app, status, warning): """ global recorded_calls - recorded_calls = set() + recorded_calls = Counter() app.builder.build_all() if app.statuscode != 0: assert False, 'failures in doctests:' + status.getvalue() # The `:skipif:` expressions are always run. # Actual tests and setup/cleanup code is only run if the `:skipif:` # expression evaluates to a False value. - assert recorded_calls == {('testsetup', ':skipif:', True), - ('testsetup', ':skipif:', False), - ('testsetup', 'body', False), - ('doctest', ':skipif:', True), - ('doctest', ':skipif:', False), - ('doctest', 'body', False), - ('testcode', ':skipif:', True), - ('testcode', ':skipif:', False), - ('testcode', 'body', False), - ('testoutput-1', ':skipif:', True), - ('testoutput-2', ':skipif:', True), - ('testoutput-2', ':skipif:', False), - ('testcleanup', ':skipif:', True), - ('testcleanup', ':skipif:', False), - ('testcleanup', 'body', False)} + # Global setup/cleanup are run before/after evaluating the `:skipif:` + # option in each directive - thus 11 additional invocations for each on top + # of the ones made for the whole test file. + assert recorded_calls == {('doctest_global_setup', 'body', True): 13, + ('testsetup', ':skipif:', True): 1, + ('testsetup', ':skipif:', False): 1, + ('testsetup', 'body', False): 1, + ('doctest', ':skipif:', True): 1, + ('doctest', ':skipif:', False): 1, + ('doctest', 'body', False): 1, + ('testcode', ':skipif:', True): 1, + ('testcode', ':skipif:', False): 1, + ('testcode', 'body', False): 1, + ('testoutput-1', ':skipif:', True): 1, + ('testoutput-2', ':skipif:', True): 1, + ('testoutput-2', ':skipif:', False): 1, + ('testcleanup', ':skipif:', True): 1, + ('testcleanup', ':skipif:', False): 1, + ('testcleanup', 'body', False): 1, + ('doctest_global_cleanup', 'body', True): 13} def record(directive, part, should_skip): global recorded_calls - recorded_calls.add((directive, part, should_skip)) + recorded_calls[(directive, part, should_skip)] += 1 return 'Recorded {} {} {}'.format(directive, part, should_skip) From c8e695fe2c54c6969c31d0aef0749428969eb851 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 17 Aug 2018 00:34:31 +0900 Subject: [PATCH 142/174] Update CHANGES for PR #5273 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index ca6e9d5be..b535fb9bf 100644 --- a/CHANGES +++ b/CHANGES @@ -196,6 +196,7 @@ Features added * quickstart: epub builder is enabled by default * #5246: Add :confval:`singlehtml_sidebars` to configure sidebars for singlehtml builder +* #5273: doctest: Skip doctest conditionally Bugs fixed ---------- From c4fa1aed340c32ff9b4b6cb2d5a6302951dea073 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Thu, 16 Aug 2018 00:54:48 +0900 Subject: [PATCH 143/174] Fix #5211: autodoc: No docs generated for functools.partial functions --- CHANGES | 1 + sphinx/ext/autodoc/__init__.py | 27 ++++++------ sphinx/util/inspect.py | 43 +++++++++++++++++-- .../target/partialfunction.py | 11 +++++ tests/test_autodoc.py | 38 ++++++++++++++++ 5 files changed, 101 insertions(+), 19 deletions(-) create mode 100644 tests/roots/test-ext-autodoc/target/partialfunction.py diff --git a/CHANGES b/CHANGES index 58431cee8..e17247476 100644 --- a/CHANGES +++ b/CHANGES @@ -29,6 +29,7 @@ Bugs fixed * #5280: autodoc: Fix wrong type annotations for complex typing * autodoc: Optional types are wrongly rendered * #5291: autodoc crashed by ForwardRef types +* #5211: autodoc: No docs generated for functools.partial functions * #5298: imgmath: math_number_all causes equations to have two numbers in html Testing diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 058fd7765..7d34e185d 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -32,7 +32,7 @@ from sphinx.util import rpartition, force_decode from sphinx.util.docstrings import prepare_docstring from sphinx.util.inspect import Signature, isdescriptor, safe_getmembers, \ safe_getattr, object_description, is_builtin_class_method, \ - isenumattribute, isclassmethod, isstaticmethod, getdoc + isenumattribute, isclassmethod, isstaticmethod, isfunction, isbuiltin, ispartial, getdoc if False: # For type annotation @@ -399,7 +399,9 @@ class Documenter(object): return True modname = self.get_attr(self.object, '__module__', None) - if modname and modname != self.modname: + if ispartial(self.object) and modname == '_functools': # for pypy + return True + elif modname and modname != self.modname: return False return True @@ -473,9 +475,8 @@ class Documenter(object): def get_doc(self, encoding=None, ignore=1): # type: (unicode, int) -> List[List[unicode]] """Decode and return lines of the docstring(s) for the object.""" - docstring = self.get_attr(self.object, '__doc__', None) - if docstring is None and self.env.config.autodoc_inherit_docstrings: - docstring = getdoc(self.object) + docstring = getdoc(self.object, self.get_attr, + self.env.config.autodoc_inherit_docstrings) # make sure we have Unicode docstrings, then sanitize and split # into lines if isinstance(docstring, text_type): @@ -599,9 +600,7 @@ class Documenter(object): # if isattr is True, the member is documented as an attribute isattr = False - doc = self.get_attr(member, '__doc__', None) - if doc is None and self.env.config.autodoc_inherit_docstrings: - doc = getdoc(member) + doc = getdoc(member, self.get_attr, self.env.config.autodoc_inherit_docstrings) # if the member __doc__ is the same as self's __doc__, it's just # inherited and therefore not the member's doc @@ -1022,12 +1021,11 @@ class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # typ @classmethod def can_document_member(cls, member, membername, isattr, parent): # type: (Any, unicode, bool, Any) -> bool - return inspect.isfunction(member) or inspect.isbuiltin(member) + return isfunction(member) or isbuiltin(member) def format_args(self): # type: () -> unicode - if inspect.isbuiltin(self.object) or \ - inspect.ismethoddescriptor(self.object): + if isbuiltin(self.object) or inspect.ismethoddescriptor(self.object): # cannot introspect arguments of a C function or method return None try: @@ -1095,7 +1093,7 @@ class ClassDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # type: # __init__ written in C? if initmeth is None or \ is_builtin_class_method(self.object, '__init__') or \ - not(inspect.ismethod(initmeth) or inspect.isfunction(initmeth)): + not(inspect.ismethod(initmeth) or isfunction(initmeth)): return None try: return Signature(initmeth, bound_method=True, has_retval=False).format_args() @@ -1304,8 +1302,7 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): # type: def format_args(self): # type: () -> unicode - if inspect.isbuiltin(self.object) or \ - inspect.ismethoddescriptor(self.object): + if isbuiltin(self.object) or inspect.ismethoddescriptor(self.object): # can never get arguments of a C function or method return None if isstaticmethod(self.object, cls=self.parent, name=self.object_name): @@ -1336,7 +1333,7 @@ class AttributeDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): @staticmethod def is_function_or_method(obj): - return inspect.isfunction(obj) or inspect.isbuiltin(obj) or inspect.ismethod(obj) + return isfunction(obj) or isbuiltin(obj) or inspect.ismethod(obj) @classmethod def can_document_member(cls, member, membername, isattr, parent): diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 64e93f267..3b5d48e2a 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -15,6 +15,7 @@ import re import sys import typing from collections import OrderedDict +from functools import partial from six import PY2, PY3, StringIO, binary_type, string_types, itervalues from six.moves import builtins @@ -99,8 +100,6 @@ if PY3: kwonlyargs, kwdefaults, annotations) else: # 2.7 - from functools import partial - def getargspec(func): # type: (Any) -> Any """Like inspect.getargspec but supports functools.partial as well.""" @@ -155,6 +154,12 @@ def isenumattribute(x): return isinstance(x, enum.Enum) +def ispartial(obj): + # type: (Any) -> bool + """Check if the object is partial.""" + return isinstance(obj, partial) + + def isclassmethod(obj): # type: (Any) -> bool """Check if the object is classmethod.""" @@ -198,6 +203,18 @@ def isdescriptor(x): return False +def isfunction(obj): + # type: (Any) -> bool + """Check if the object is function.""" + return inspect.isfunction(obj) or ispartial(obj) and inspect.isfunction(obj.func) + + +def isbuiltin(obj): + # type: (Any) -> bool + """Check if the object is builtin.""" + return inspect.isbuiltin(obj) or ispartial(obj) and inspect.isbuiltin(obj.func) + + def safe_getattr(obj, name, *defargs): # type: (Any, unicode, unicode) -> object """A getattr() that turns all exceptions into AttributeErrors.""" @@ -601,7 +618,7 @@ class Signature(object): if sys.version_info >= (3, 5): - getdoc = inspect.getdoc + _getdoc = inspect.getdoc else: # code copied from the inspect.py module of the standard library # of Python 3.5 @@ -679,7 +696,7 @@ else: return doc return None - def getdoc(object): + def _getdoc(object): """Get the documentation string for an object. All tabs are expanded to spaces. To clean up docstrings that are @@ -697,3 +714,21 @@ else: if not isinstance(doc, str): return None return inspect.cleandoc(doc) + + +def getdoc(obj, attrgetter=safe_getattr, allow_inherited=False): + # type: (Any, Callable, bool) -> unicode + """Get the docstring for the object. + + This tries to obtain the docstring for some kind of objects additionally: + + * partial functions + * inherited docstring + """ + doc = attrgetter(obj, '__doc__', None) + if ispartial(obj) and doc == obj.__class__.__doc__: + return getdoc(obj.func) + elif doc is None and allow_inherited: + doc = _getdoc(obj) + + return doc diff --git a/tests/roots/test-ext-autodoc/target/partialfunction.py b/tests/roots/test-ext-autodoc/target/partialfunction.py new file mode 100644 index 000000000..727a62680 --- /dev/null +++ b/tests/roots/test-ext-autodoc/target/partialfunction.py @@ -0,0 +1,11 @@ +from functools import partial + + +def func1(): + """docstring of func1""" + pass + + +func2 = partial(func1) +func3 = partial(func1) +func3.__doc__ = "docstring of func3" diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 53d8a1e14..97e03c886 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -912,6 +912,44 @@ def test_generate(): 'module', 'autodoc_missing_imports') +@pytest.mark.usefixtures('setup_test') +def test_partialfunction(): + def call_autodoc(objtype, name): + inst = app.registry.documenters[objtype](directive, name) + inst.generate() + result = list(directive.result) + del directive.result[:] + return result + + options.members = ALL + #options.undoc_members = True + expected = [ + '', + '.. py:module:: target.partialfunction', + '', + '', + '.. py:function:: func1()', + ' :module: target.partialfunction', + '', + ' docstring of func1', + ' ', + '', + '.. py:function:: func2()', + ' :module: target.partialfunction', + '', + ' docstring of func1', + ' ', + '', + '.. py:function:: func3()', + ' :module: target.partialfunction', + '', + ' docstring of func3', + ' ' + ] + + assert call_autodoc('module', 'target.partialfunction') == expected + + @pytest.mark.skipif(sys.version_info < (3, 4), reason='functools.partialmethod is available on py34 or above') @pytest.mark.usefixtures('setup_test') From a450eb7a7a48fd706c6cdbe6c35be63fd7ff13e6 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 17 Aug 2018 10:32:58 +0900 Subject: [PATCH 144/174] Fix #5306: autodoc: ``getargspec()`` raises NameError for invalid typehints --- CHANGES | 1 + sphinx/ext/autodoc/inspector.py | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index e17247476..f3282e509 100644 --- a/CHANGES +++ b/CHANGES @@ -30,6 +30,7 @@ Bugs fixed * autodoc: Optional types are wrongly rendered * #5291: autodoc crashed by ForwardRef types * #5211: autodoc: No docs generated for functools.partial functions +* #5306: autodoc: ``getargspec()`` raises NameError for invalid typehints * #5298: imgmath: math_number_all causes equations to have two numbers in html Testing diff --git a/sphinx/ext/autodoc/inspector.py b/sphinx/ext/autodoc/inspector.py index 6e07c9547..be42237c6 100644 --- a/sphinx/ext/autodoc/inspector.py +++ b/sphinx/ext/autodoc/inspector.py @@ -130,8 +130,11 @@ def formatargspec(function, args, varargs=None, varkw=None, defaults=None, else: return value - introspected_hints = (typing.get_type_hints(function) # type: ignore - if typing and hasattr(function, '__code__') else {}) + try: + introspected_hints = (typing.get_type_hints(function) # type: ignore + if typing and hasattr(function, '__code__') else {}) + except Exception: + introspected_hints = {} fd = StringIO() fd.write('(') From 7975d73a17f86b395714c863d6f8436f77968afa Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 17 Aug 2018 10:39:02 +0900 Subject: [PATCH 145/174] Fix #5306: autodoc: emit a warning for invalid typehints --- CHANGES | 1 + sphinx/util/inspect.py | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index c231d3851..c752e6af9 100644 --- a/CHANGES +++ b/CHANGES @@ -197,6 +197,7 @@ Features added * #5246: Add :confval:`singlehtml_sidebars` to configure sidebars for singlehtml builder * #5273: doctest: Skip doctest conditionally +* #5306: autodoc: emit a warning for invalid typehints Bugs fixed ---------- diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 9898506cc..487b95f1f 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -20,12 +20,15 @@ from six import PY2, PY3, StringIO, binary_type, string_types, itervalues from six.moves import builtins from sphinx.util import force_decode +from sphinx.util import logging from sphinx.util.pycompat import NoneType if False: # For type annotation from typing import Any, Callable, Dict, List, Tuple, Type # NOQA +logger = logging.getLogger(__name__) + memory_address_re = re.compile(r' at 0x[0-9a-f]{8,16}(?=>)', re.IGNORECASE) @@ -339,7 +342,8 @@ class Signature(object): try: self.annotations = typing.get_type_hints(subject) # type: ignore - except Exception: + except Exception as exc: + logger.warning('Invalid type annotation found on %r. Ingored: %r', subject, exc) self.annotations = {} if bound_method: From d299869313c1293e1b6f14e96f1af3d252c679d1 Mon Sep 17 00:00:00 2001 From: Tony Roberts Date: Fri, 17 Aug 2018 12:43:24 +0100 Subject: [PATCH 146/174] Add PyXLL to EXAMPLES --- EXAMPLES | 2 ++ 1 file changed, 2 insertions(+) diff --git a/EXAMPLES b/EXAMPLES index b9102b8f3..7606bcd5b 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -644,6 +644,7 @@ Homepages and other non-documentation sites * `Deep Learning Tutorials`__ (sphinxdoc) * `Loyola University Chicago COMP 339-439 Distributed Systems course`__ (sphinx_bootstrap_theme) * `Pylearn2`__ (sphinxdoc, customized) +* `PyXLL`__ (sphinx_bootstrap_theme, customized) * `SciPy Cookbook`__ (sphinx_rtd_theme) * `The Wine Cellar Book`__ (sphinxdoc) * `Thomas Cokelaer's Python, Sphinx and reStructuredText tutorials`__ (standard) @@ -655,6 +656,7 @@ __ https://lab.miletic.net/ __ http://www.deeplearning.net/tutorial/ __ http://books.cs.luc.edu/distributedsystems/ __ http://www.deeplearning.net/software/pylearn2/ +__ https://www.pyxll.com/ __ https://scipy-cookbook.readthedocs.io/ __ https://www.thewinecellarbook.com/doc/en/ __ http://thomas-cokelaer.info/tutorials/ From 73ae1ac834fa3cdd12d9d55ed14c2cfcd8ba43c4 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Fri, 17 Aug 2018 13:49:44 +0200 Subject: [PATCH 147/174] C++, add parsing of basic new expressions. --- CHANGES | 2 +- sphinx/domains/cpp.py | 153 +++++++++++++++++++++++++++++++++------ tests/test_domain_cpp.py | 8 +- 3 files changed, 140 insertions(+), 23 deletions(-) diff --git a/CHANGES b/CHANGES index 13ff43b19..d3bcb0f5c 100644 --- a/CHANGES +++ b/CHANGES @@ -213,7 +213,7 @@ Bugs fixed * #5191: C++, prevent nested declarations in functions to avoid lookup problems. * #5126: C++, add missing isPack method for certain template parameter types. * #5187: C++, parse attributes on declerators as well. -* C++, parse delete expressions as well. +* C++, parse delete expressions and basic new expressions as well. * #5002: graphviz: SVGs do not adapt to the column width Testing diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 837b6390c..bb36ca638 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1106,6 +1106,80 @@ class ASTNoexceptExpr(ASTBase): signode.append(nodes.Text(')')) +class ASTNewExpr(ASTBase): + def __init__(self, rooted, isNewTypeId, typ, initList, initType): + # type: (bool, bool, ASTType, List[Any], unicode) -> None + self.rooted = rooted + self.isNewTypeId = isNewTypeId + self.typ = typ + self.initList = initList + self.initType = initType + if self.initList is not None: + assert self.initType in ')}' + + def _stringify(self, transform): + res = [] + if self.rooted: + res.append('::') + res.append('new ') + # TODO: placement + if self.isNewTypeId: + res.append(transform(self.typ)) + else: + assert False + if self.initList is not None: + if self.initType == ')': + res.append('(') + first = True + for e in self.initList: + if not first: + res.append(', ') + first = False + res.append(transform(e)) + res.append(self.initType) + return u''.join(res) + + def get_id(self, version): + # the array part will be in the type mangling, so na is not used + res = ['nw'] + # TODO: placement + res.append('_') + res.append(self.typ.get_id(version)) + if self.initList is not None: + if self.initType == ')': + res.append('pi') + for e in self.initList: + res.append(e.get_id(version)) + res.append('E') + else: + assert False + else: + res.append('E') + return u''.join(res) + + def describe_signature(self, signode, mode, env, symbol): + if self.rooted: + signode.append(nodes.Text('::')) + signode.append(nodes.Text('new ')) + # TODO: placement + if self.isNewTypeId: + self.typ.describe_signature(signode, mode, env, symbol) + else: + assert False + if self.initList is not None: + if self.initType == ')': + signode.append(nodes.Text('(')) + first = True + for e in self.initList: + if not first: + signode.append(nodes.Text(', ')) + first = False + e.describe_signature(signode, mode, env, symbol) + signode.append(nodes.Text(')')) + else: + assert False + + class ASTDeleteExpr(ASTBase): def __init__(self, rooted, array, expr): self.rooted = rooted @@ -4381,6 +4455,36 @@ class DefinitionParser(object): return res return self._parse_nested_name() + def _parse_expression_list_or_braced_init_list(self): + # type: () -> Tuple[List[Any], unicode] + self.skip_ws() + if self.skip_string_and_ws('('): + close = ')' + name = 'parenthesized expression-list' + elif self.skip_string_and_ws('{'): + close = '}' + name = 'braced-init-list' + self.fail('Sorry, braced-init-list not yet supported.') + else: + return None, None + exprs = [] + self.skip_ws() + if not self.skip_string(close): + while True: + self.skip_ws() + expr = self._parse_expression(inTemplate=False) + self.skip_ws() + if self.skip_string('...'): + exprs.append(ASTPackExpansionExpr(expr)) + else: + exprs.append(expr) + self.skip_ws() + if self.skip_string(close): + break + if not self.skip_string(','): + self.fail("Error in %s, expected ',' or '%s'." % (name, close)) + return exprs, close + def _parse_postfix_expression(self): # -> primary # | postfix "[" expression "]" @@ -4523,25 +4627,13 @@ class DefinitionParser(object): if self.skip_string('--'): postFixes.append(ASTPostfixDec()) # type: ignore continue - if self.skip_string_and_ws('('): - # TODO: handled braced init - exprs = [] - self.skip_ws() - if not self.skip_string(')'): - while True: - self.skip_ws() - expr = self._parse_expression(inTemplate=False) - self.skip_ws() - if self.skip_string('...'): - exprs.append(ASTPackExpansionExpr(expr)) - else: - exprs.append(expr) - self.skip_ws() - if self.skip_string(')'): - break - if not self.skip_string(','): - self.fail("Error in cast or call, expected ',' or ')'.") - postFixes.append(ASTPostfixCallExpr(exprs)) # type: ignore + lst, typ = self._parse_expression_list_or_braced_init_list() + if lst is not None: + if typ == ')': + postFixes.append(ASTPostfixCallExpr(lst)) # type: ignore + else: + assert typ == '}' + assert False continue break if len(postFixes) == 0: @@ -4610,7 +4702,24 @@ class DefinitionParser(object): if not self.skip_word_and_ws('new'): self.pos = pos else: - self.fail("Sorry, new-expressions not yet supported.") + # new-placement[opt] new-type-id new-initializer[opt] + # new-placement[opt] ( type-id ) new-initializer[opt] + isNewTypeId = True + if self.skip_string_and_ws('('): + # either this is a new-placement or it's the second production + # without placement, and it's actually the ( type-id ) part + self.fail("Sorry, neither new-placement nor parenthesised type-id " + "in new-epression is supported yet.") + # set isNewTypeId = False if it's (type-id) + if isNewTypeId: + declSpecs = self._parse_decl_specs(outer=None) + decl = self._parse_declarator(named=False, paramMode="new") + else: + self.fail("Sorry, parenthesised type-id in new expression not yet supported.") + lst, typ = self._parse_expression_list_or_braced_init_list() + if lst: + assert typ in ")}" + return ASTNewExpr(rooted, isNewTypeId, ASTType(declSpecs, decl), lst, typ) # delete-expression pos = self.pos rooted = self.skip_string('::') @@ -4972,6 +5081,8 @@ class DefinitionParser(object): def _parse_parameters_and_qualifiers(self, paramMode): # type: (unicode) -> ASTParametersQualifiers + if paramMode == 'new': + return None self.skip_ws() if not self.skip_string('('): if paramMode == 'function': @@ -5213,7 +5324,7 @@ class DefinitionParser(object): def _parse_declarator(self, named, paramMode, typed=True): # type: (Union[bool, unicode], unicode, bool) -> Any # 'typed' here means 'parse return type stuff' - if paramMode not in ('type', 'function', 'operatorCast'): + if paramMode not in ('type', 'function', 'operatorCast', 'new'): raise Exception( "Internal error, unknown paramMode '%s'." % paramMode) prevErrors = [] diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index e26da217e..0fe8d5c19 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -171,7 +171,13 @@ def test_expressions(): exprCheck('sizeof -42', 'szngL42E') exprCheck('alignof(T)', 'at1T') exprCheck('noexcept(-42)', 'nxngL42E') - # TODO: new-expression + # new-expression + exprCheck('new int', 'nw_iE') + exprCheck('new volatile int', 'nw_ViE') + exprCheck('new int[42]', 'nw_AL42E_iE') + exprCheck('new int()', 'nw_ipiE') + exprCheck('new int(5, 42)', 'nw_ipiL5EL42EE') + # delete-expression exprCheck('delete p', 'dl1p') exprCheck('delete [] p', 'da1p') exprCheck('::delete p', 'dl1p') From a22f9df684bbff1deb43f6e22d3154e74eed30a5 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 17 Aug 2018 22:25:13 +0900 Subject: [PATCH 148/174] Fix #5294: sphinx-quickstart blank prompts in PowerShell --- CHANGES | 1 + sphinx/cmd/quickstart.py | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index f3282e509..f03d1172c 100644 --- a/CHANGES +++ b/CHANGES @@ -32,6 +32,7 @@ Bugs fixed * #5211: autodoc: No docs generated for functools.partial functions * #5306: autodoc: ``getargspec()`` raises NameError for invalid typehints * #5298: imgmath: math_number_all causes equations to have two numbers in html +* #5294: sphinx-quickstart blank prompts in PowerShell Testing -------- diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index 8b928b478..01b6ca3be 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -78,6 +78,12 @@ DEFAULTS = { PROMPT_PREFIX = '> ' +if sys.platform == 'win32': + # On Windows, show questions as bold because of color scheme of PowerShell (refs: #5294). + COLOR_QUESTION = 'bold' +else: + COLOR_QUESTION = 'purple' + # function to get input from terminal -- overridden by the test suite def term_input(prompt): @@ -189,7 +195,7 @@ def do_prompt(text, default=None, validator=nonempty): prompt = prompt.encode('utf-8') except UnicodeEncodeError: prompt = prompt.encode('latin1') - prompt = colorize('purple', prompt, input_mode=True) + prompt = colorize(COLOR_QUESTION, prompt, input_mode=True) x = term_input(prompt).strip() if default and not x: x = default From 87029392fd73521a3d25e3ceba363c19d93a3c7a Mon Sep 17 00:00:00 2001 From: Lewis Haley Date: Thu, 26 Jul 2018 11:43:28 +0100 Subject: [PATCH 149/174] test_autodoc: fix mutable function default argument in do_autodoc Setting mutable types as default arguments is bad practice because the value is only initialised once. This means that defaults arguments of lists and dictionaries which are modified during code execution *stay* modified between calls. In this case, the `options` dictionary accumulated options as more and more test cases were executed. Without this change, the tests added in the next commit do not pass. See: https://stackoverflow.com/questions/1132941/least-astonishment-and-the-mutable-default-argument --- tests/test_autodoc.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index d3e69766f..a54c9c2e6 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -34,7 +34,9 @@ else: ROGER_METHOD = ' .. py:classmethod:: Class.roger(a, e=5, f=6)' -def do_autodoc(app, objtype, name, options={}): +def do_autodoc(app, objtype, name, options=None): + if options is None: + options = {} doccls = app.registry.documenters[objtype] docoptions = process_documenter_options(doccls, app.config, options) bridge = DocumenterBridge(app.env, LoggingReporter(''), docoptions, 1) From 6e1e35c98ac29397d4552caf72710ccf4bf98bea Mon Sep 17 00:00:00 2001 From: Lewis Haley Date: Wed, 8 Aug 2018 16:26:11 +0100 Subject: [PATCH 150/174] autodoc: allow specifying values to global arguments Previously, users could specify a *list* of flags in their config files. The flags were directive names that would otherwise be present in the .rst files. However, as a list, it was not possible to specify values to those flags, which *is* possible in .rst files. For example, in .rst you could say :special-members: __init__, __iter__ And this would cause autodoc to generate documents for these methods that it would otherwise ignore. This commit changes the config option to instead accept a dictionary. This is a dictionary whose keys can contain the same flag-names as before, but whose values can contain the arguments as seen in .rst files. The old list is still supported, for backwards compatibility, but the data is transformed into a dictionary when the user's config is loaded. --- doc/usage/extensions/autodoc.rst | 17 ++++ sphinx/ext/autodoc/__init__.py | 43 ++++++++- sphinx/ext/autodoc/directive.py | 2 +- .../roots/test-ext-autodoc/target/__init__.py | 15 ++++ tests/test_autodoc.py | 87 +++++++++++++++++-- 5 files changed, 155 insertions(+), 9 deletions(-) diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 385254734..285756149 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -353,8 +353,25 @@ There are also new config values that you can set: the directive will be interpreted as if only ``:members:`` was given. + You can also set `autodoc_default_flags` to a dictionary, mapping option + names to the values which can used in .rst files. For example:: + + autodoc_default_flags = { + 'members': 'var1, var2', + 'member-order': 'bysource', + 'special-members': '__init__', + 'undoc-members': None, + } + + Setting ``None`` is equivalent to giving the option name in the list format + (i.e. it means "yes/true/on"). + .. versionadded:: 1.0 + .. versionchanged:: 1.8 + + Specifying in dictionary format added. + .. confval:: autodoc_docstring_signature Functions imported from C modules cannot be introspected, and therefore the diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 4a9b59537..6671df579 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -15,6 +15,7 @@ import inspect import re import sys import warnings +from typing import Any from docutils.statemachine import ViewList from six import iteritems, itervalues, text_type, class_types, string_types @@ -41,6 +42,7 @@ if False: from docutils import nodes # NOQA from docutils.utils import Reporter # NOQA from sphinx.application import Sphinx # NOQA + from sphinx.config import Config # NOQA from sphinx.environment import BuildEnvironment # NOQA from sphinx.ext.autodoc.directive import DocumenterBridge # NOQA @@ -679,8 +681,13 @@ class Documenter(object): # remove members given by exclude-members if self.options.exclude_members: - members = [(membername, member) for (membername, member) in members - if membername not in self.options.exclude_members] + members = [ + (membername, member) for (membername, member) in members + if ( + self.options.exclude_members is ALL or + membername not in self.options.exclude_members + ) + ] # document non-skipped members memberdocumenters = [] # type: List[Tuple[Documenter, bool]] @@ -1528,6 +1535,34 @@ def autodoc_attrgetter(app, obj, name, *defargs): return safe_getattr(obj, name, *defargs) +def convert_autodoc_default_flags(app, config): + # type: (Sphinx, Config) -> None + """This converts the old list-of-flags (strings) to a dict of Nones.""" + if isinstance(config.autodoc_default_flags, dict): + # Already new-style + return + + elif not isinstance(config.autodoc_default_flags, list): + # Not old-style list + logger.error( + __("autodoc_default_flags is invalid type %r"), + config.autodoc_default_flags.__class__.__name__ + ) + return + + autodoc_default_flags = {} # type: Dict[unicode, Any] + for option in config.autodoc_default_flags: + if isinstance(option, string_types): + autodoc_default_flags[option] = None + else: + logger.warning( + __("Ignoring invalid option in autodoc_default_flags: %r"), + option + ) + + config.autodoc_default_flags = autodoc_default_flags # type: ignore + + def setup(app): # type: (Sphinx) -> Dict[unicode, Any] app.add_autodocumenter(ModuleDocumenter) @@ -1541,7 +1576,7 @@ def setup(app): app.add_config_value('autoclass_content', 'class', True) app.add_config_value('autodoc_member_order', 'alphabetic', True) - app.add_config_value('autodoc_default_flags', [], True) + app.add_config_value('autodoc_default_flags', {}, True, Any) app.add_config_value('autodoc_docstring_signature', True, True) app.add_config_value('autodoc_mock_imports', [], True) app.add_config_value('autodoc_warningiserror', True, True) @@ -1550,4 +1585,6 @@ def setup(app): app.add_event('autodoc-process-signature') app.add_event('autodoc-skip-member') + app.connect('config-inited', convert_autodoc_default_flags) + return {'version': sphinx.__display_version__, 'parallel_read_safe': True} diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index 64d19fcc7..aabf6b47d 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -68,7 +68,7 @@ def process_documenter_options(documenter, config, options): else: negated = options.pop('no-' + name, True) is None if name in config.autodoc_default_flags and not negated: - options[name] = None + options[name] = config.autodoc_default_flags[name] return Options(assemble_option_dict(options.items(), documenter.option_spec)) diff --git a/tests/roots/test-ext-autodoc/target/__init__.py b/tests/roots/test-ext-autodoc/target/__init__.py index d94665bbf..201e84efd 100644 --- a/tests/roots/test-ext-autodoc/target/__init__.py +++ b/tests/roots/test-ext-autodoc/target/__init__.py @@ -234,3 +234,18 @@ class EnumCls(enum.Enum): val3 = 34 """doc for val3""" val4 = 34 + + +class CustomIter(object): + def __init__(self): + """Create a new `CustomIter`.""" + self.values = range(10) + + def __iter__(self): + """Iterate squares of each value.""" + for i in self.values: + yield i ** 2 + + def snafucate(self): + """Makes this snafucated.""" + print("snafucated") diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index a54c9c2e6..a559fb164 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -11,6 +11,7 @@ """ import re +import platform import sys from warnings import catch_warnings @@ -19,7 +20,8 @@ from docutils.statemachine import ViewList from six import PY3 from sphinx.ext.autodoc import ( - AutoDirective, ModuleLevelDocumenter, cut_lines, between, ALL + AutoDirective, ModuleLevelDocumenter, cut_lines, between, ALL, + convert_autodoc_default_flags ) from sphinx.ext.autodoc.directive import DocumenterBridge, process_documenter_options from sphinx.testing.util import SphinxTestApp, Struct # NOQA @@ -33,6 +35,8 @@ if PY3: else: ROGER_METHOD = ' .. py:classmethod:: Class.roger(a, e=5, f=6)' +IS_PYPY = platform.python_implementation() == 'PyPy' + def do_autodoc(app, objtype, name, options=None): if options is None: @@ -1414,21 +1418,94 @@ def test_partialmethod(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') -def test_autodoc_default_flags(app): +def test_autodoc_default_flags__as_list__converted(app): + orig = [ + 'members', + 'undoc-members', + ('skipped', 1, 2), + {'also': 'skipped'}, + ] + expected = { + 'members': None, + 'undoc-members': None, + } + app.config.autodoc_default_flags = orig + convert_autodoc_default_flags(app, app.config) + assert app.config.autodoc_default_flags == expected + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_default_flags__as_dict__no_conversion(app): + orig = { + 'members': 'this,that,other', + 'undoc-members': None, + } + app.config.autodoc_default_flags = orig + convert_autodoc_default_flags(app, app.config) + assert app.config.autodoc_default_flags == orig + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_default_flags__with_flags(app): # no settings actual = do_autodoc(app, 'class', 'target.EnumCls') assert ' .. py:attribute:: EnumCls.val1' not in actual assert ' .. py:attribute:: EnumCls.val4' not in actual + actual = do_autodoc(app, 'class', 'target.CustomIter') + assert ' .. py:method:: target.CustomIter' not in actual # with :members: - app.config.autodoc_default_flags = ['members'] + app.config.autodoc_default_flags = {'members': None} actual = do_autodoc(app, 'class', 'target.EnumCls') assert ' .. py:attribute:: EnumCls.val1' in actual assert ' .. py:attribute:: EnumCls.val4' not in actual # with :members: and :undoc-members: - app.config.autodoc_default_flags = ['members', - 'undoc-members'] + app.config.autodoc_default_flags = { + 'members': None, + 'undoc-members': None, + } actual = do_autodoc(app, 'class', 'target.EnumCls') assert ' .. py:attribute:: EnumCls.val1' in actual assert ' .. py:attribute:: EnumCls.val4' in actual + + # with :special-members: + # Note that :members: must be *on* for :special-members: to work. + app.config.autodoc_default_flags = { + 'members': None, + 'special-members': None + } + actual = do_autodoc(app, 'class', 'target.CustomIter') + assert ' .. py:method:: CustomIter.__init__()' in actual + assert ' Create a new `CustomIter`.' in actual + assert ' .. py:method:: CustomIter.__iter__()' in actual + assert ' Iterate squares of each value.' in actual + if not IS_PYPY: + assert ' .. py:attribute:: CustomIter.__weakref__' in actual + assert ' list of weak references to the object (if defined)' in actual + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_autodoc_default_flags__with_values(app): + # with :members: + app.config.autodoc_default_flags = {'members': 'val1,val2'} + actual = do_autodoc(app, 'class', 'target.EnumCls') + assert ' .. py:attribute:: EnumCls.val1' in actual + assert ' .. py:attribute:: EnumCls.val2' in actual + assert ' .. py:attribute:: EnumCls.val3' not in actual + assert ' .. py:attribute:: EnumCls.val4' not in actual + + # with :special-members: + # Note that :members: must be *on* for :special-members: to work. + app.config.autodoc_default_flags = { + 'members': None, + 'special-members': '__init__,__iter__', + } + actual = do_autodoc(app, 'class', 'target.CustomIter') + assert ' .. py:method:: CustomIter.__init__()' in actual + assert ' Create a new `CustomIter`.' in actual + assert ' .. py:method:: CustomIter.__iter__()' in actual + assert ' Iterate squares of each value.' in actual + if not IS_PYPY: + assert ' .. py:attribute:: CustomIter.__weakref__' not in actual + assert ' list of weak references to the object (if defined)' not in actual From f196a92055df2ef7603ad777abfaa2989d4b6744 Mon Sep 17 00:00:00 2001 From: Lewis Haley Date: Fri, 17 Aug 2018 16:02:11 +0100 Subject: [PATCH 151/174] autodoc: add 'exclude-members' to user global options As the previous commit explains, it is now possible to specify arguments to the global options in config files. This means that we can now include the `exclude-members` option in this global configuration. Previously, there was no point including this option because it makes no sense without arguments. Including this option means users have the flexibility of explicitly including which special methods they want using (e.g.): :special-members: __init__, __iter__ or explicitly excluding which special-members (or other members) they want using (e.g.): :exclude-members: __weakref__, __hash__ --- doc/usage/extensions/autodoc.rst | 4 ++- sphinx/ext/autodoc/directive.py | 2 +- tests/test_autodoc.py | 52 ++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 2 deletions(-) diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 285756149..2b2a5f3ac 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -341,7 +341,8 @@ There are also new config values that you can set: This value is a list of autodoc directive flags that should be automatically applied to all autodoc directives. The supported flags are ``'members'``, ``'undoc-members'``, ``'private-members'``, ``'special-members'``, - ``'inherited-members'``, ``'show-inheritance'`` and ``'ignore-module-all'``. + ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` + and ``'exclude-members'``. If you set one of these flags in this config value, you can use a negated form, :samp:`'no-{flag}'`, in an autodoc directive, to disable it once. @@ -361,6 +362,7 @@ There are also new config values that you can set: 'member-order': 'bysource', 'special-members': '__init__', 'undoc-members': None, + 'exclude-members': '__weakref__' } Setting ``None`` is equivalent to giving the option name in the list format diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index aabf6b47d..34f7567d4 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -31,7 +31,7 @@ logger = logging.getLogger(__name__) # common option names for autodoc directives AUTODOC_DEFAULT_OPTIONS = ['members', 'undoc-members', 'inherited-members', 'show-inheritance', 'private-members', 'special-members', - 'ignore-module-all'] + 'ignore-module-all', 'exclude-members'] class DummyOptionSpec(object): diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index a559fb164..0cd543ad7 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -1484,6 +1484,32 @@ def test_autodoc_default_flags__with_flags(app): assert ' .. py:attribute:: CustomIter.__weakref__' in actual assert ' list of weak references to the object (if defined)' in actual + # :exclude-members: None - has no effect. Unlike :members:, + # :special-members:, etc. where None == "include all", here None means + # "no/false/off". + app.config.autodoc_default_flags = { + 'members': None, + 'exclude-members': None, + } + actual = do_autodoc(app, 'class', 'target.EnumCls') + assert ' .. py:attribute:: EnumCls.val1' in actual + assert ' .. py:attribute:: EnumCls.val4' not in actual + app.config.autodoc_default_flags = { + 'members': None, + 'special-members': None, + 'exclude-members': None, + } + actual = do_autodoc(app, 'class', 'target.CustomIter') + assert ' .. py:method:: CustomIter.__init__()' in actual + assert ' Create a new `CustomIter`.' in actual + assert ' .. py:method:: CustomIter.__iter__()' in actual + assert ' Iterate squares of each value.' in actual + if not IS_PYPY: + assert ' .. py:attribute:: CustomIter.__weakref__' in actual + assert ' list of weak references to the object (if defined)' in actual + assert ' .. py:method:: CustomIter.snafucate()' in actual + assert ' Makes this snafucated.' in actual + @pytest.mark.sphinx('html', testroot='ext-autodoc') def test_autodoc_default_flags__with_values(app): @@ -1509,3 +1535,29 @@ def test_autodoc_default_flags__with_values(app): if not IS_PYPY: assert ' .. py:attribute:: CustomIter.__weakref__' not in actual assert ' list of weak references to the object (if defined)' not in actual + + # with :exclude-members: + app.config.autodoc_default_flags = { + 'members': None, + 'exclude-members': 'val1' + } + actual = do_autodoc(app, 'class', 'target.EnumCls') + assert ' .. py:attribute:: EnumCls.val1' not in actual + assert ' .. py:attribute:: EnumCls.val2' in actual + assert ' .. py:attribute:: EnumCls.val3' in actual + assert ' .. py:attribute:: EnumCls.val4' not in actual + app.config.autodoc_default_flags = { + 'members': None, + 'special-members': None, + 'exclude-members': '__weakref__,snafucate', + } + actual = do_autodoc(app, 'class', 'target.CustomIter') + assert ' .. py:method:: CustomIter.__init__()' in actual + assert ' Create a new `CustomIter`.' in actual + assert ' .. py:method:: CustomIter.__iter__()' in actual + assert ' Iterate squares of each value.' in actual + if not IS_PYPY: + assert ' .. py:attribute:: CustomIter.__weakref__' not in actual + assert ' list of weak references to the object (if defined)' not in actual + assert ' .. py:method:: CustomIter.snafucate()' not in actual + assert ' Makes this snafucated.' not in actual From e8c6b70de6c98faf6d91f0c89aee946784a33ff4 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 18 Aug 2018 14:53:58 +0900 Subject: [PATCH 152/174] Fix #5198: document not in toctree warning when including files only for parallel builds --- sphinx/environment/__init__.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index 4d3935faf..db5a229dc 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -331,8 +331,9 @@ class BuildEnvironment(object): self.all_docs[docname] = other.all_docs[docname] if docname in other.reread_always: self.reread_always.add(docname) - if docname in other.included: - self.included.add(docname) + + for docname in other.included: + self.included.add(docname) for version, changes in other.versionchanges.items(): self.versionchanges.setdefault(version, []).extend( From 07c3f24aad4e1b2bd550f8f6b87ec9bcbb3fc08e Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 18 Aug 2018 15:17:00 +0900 Subject: [PATCH 153/174] Update CHANGES for PR #5215 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index 67b386fe3..d9b28c7d3 100644 --- a/CHANGES +++ b/CHANGES @@ -198,6 +198,7 @@ Features added builder * #5273: doctest: Skip doctest conditionally * #5306: autodoc: emit a warning for invalid typehints +* #5215: autodoc: :confval:`autodoc_default_flags` accepts option values as dict Bugs fixed ---------- From 6b98eb76f9c416c12a40937092095deb2f523703 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Sun, 12 Aug 2018 18:57:19 +0200 Subject: [PATCH 154/174] C++, improve type info --- sphinx/domains/cpp.py | 170 +++++++++++++++++++++--------------------- 1 file changed, 83 insertions(+), 87 deletions(-) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index bb36ca638..b67747609 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -1493,7 +1493,7 @@ class ASTIdentifier(ASTBase): class ASTTemplateKeyParamPackIdDefault(ASTBase): def __init__(self, key, identifier, parameterPack, default): - # type: (unicode, Any, bool, Any) -> None + # type: (unicode, ASTIdentifier, bool, ASTType) -> None assert key if parameterPack: assert default is None @@ -1503,7 +1503,7 @@ class ASTTemplateKeyParamPackIdDefault(ASTBase): self.default = default def get_identifier(self): - # type: () -> unicode + # type: () -> ASTIdentifier return self.identifier def get_id(self, version): @@ -1550,7 +1550,7 @@ class ASTTemplateKeyParamPackIdDefault(ASTBase): class ASTTemplateParamType(ASTBase): def __init__(self, data): - # type: (Any) -> None + # type: (ASTTemplateKeyParamPackIdDefault) -> None assert data self.data = data @@ -1565,7 +1565,7 @@ class ASTTemplateParamType(ASTBase): return self.data.parameterPack def get_identifier(self): - # type: () -> unicode + # type: () -> ASTIdentifier return self.data.get_identifier() def get_id(self, version, objectType=None, symbol=None): @@ -1629,7 +1629,7 @@ class ASTTemplateParamConstrainedTypeWithInit(ASTBase): class ASTTemplateParamTemplateType(ASTBase): def __init__(self, nestedParams, data): - # type: (Any, Any) -> None + # type: (Any, ASTTemplateKeyParamPackIdDefault) -> None assert nestedParams assert data self.nestedParams = nestedParams @@ -1646,7 +1646,7 @@ class ASTTemplateParamTemplateType(ASTBase): return self.data.parameterPack def get_identifier(self): - # type: () -> unicode + # type: () -> ASTIdentifier return self.data.get_identifier() def get_id(self, version, objectType=None, symbol=None): @@ -1686,7 +1686,7 @@ class ASTTemplateParamNonType(ASTBase): return self.param.isPack def get_identifier(self): - # type: () -> unicode + # type: () -> ASTIdentifier name = self.param.name if name: assert len(name.names) == 1 @@ -1766,7 +1766,7 @@ class ASTTemplateParams(ASTBase): class ASTTemplateIntroductionParameter(ASTBase): def __init__(self, identifier, parameterPack): - # type: (Any, Any) -> None + # type: (ASTIdentifier, bool) -> None self.identifier = identifier self.parameterPack = parameterPack @@ -1781,7 +1781,7 @@ class ASTTemplateIntroductionParameter(ASTBase): return self.parameterPack def get_identifier(self): - # type: () -> unicode + # type: () -> ASTIdentifier return self.identifier def get_id(self, version, objectType=None, symbol=None): @@ -1900,11 +1900,10 @@ class ASTTemplateDeclarationPrefix(ASTBase): t.describe_signature(signode, 'lastIsName', env, symbol, lineSpec) -class ASTOperatorBuildIn(ASTBase): - def __init__(self, op): - # type: (unicode) -> None - self.op = op +############################################################################################## + +class ASTOperator(ASTBase): def is_anon(self): return False @@ -1912,6 +1911,25 @@ class ASTOperatorBuildIn(ASTBase): # type: () -> bool return True + def get_id(self, version): + # type: (int) -> unicode + raise NotImplementedError() + + def describe_signature(self, signode, mode, env, prefix, templateArgs, symbol): + # type: (addnodes.desc_signature, unicode, Any, unicode, unicode, Symbol) -> None + _verify_description_mode(mode) + identifier = text_type(self) + if mode == 'lastIsName': + signode += addnodes.desc_name(identifier, identifier) + else: + signode += addnodes.desc_addname(identifier, identifier) + + +class ASTOperatorBuildIn(ASTOperator): + def __init__(self, op): + # type: (unicode) -> None + self.op = op + def get_id(self, version): # type: (int) -> unicode if version == 1: @@ -1929,28 +1947,12 @@ class ASTOperatorBuildIn(ASTBase): else: return u'operator' + self.op - def describe_signature(self, signode, mode, env, prefix, templateArgs, symbol): - # type: (addnodes.desc_signature, unicode, Any, unicode, unicode, Symbol) -> None - _verify_description_mode(mode) - identifier = text_type(self) - if mode == 'lastIsName': - signode += addnodes.desc_name(identifier, identifier) - else: - signode += addnodes.desc_addname(identifier, identifier) - -class ASTOperatorType(ASTBase): +class ASTOperatorType(ASTOperator): def __init__(self, type): # type: (Any) -> None self.type = type - def is_anon(self): - return False - - def is_operator(self): - # type: () -> bool - return True - def get_id(self, version): # type: (int) -> unicode if version == 1: @@ -1965,28 +1967,12 @@ class ASTOperatorType(ASTBase): # type: () -> unicode return text_type(self) - def describe_signature(self, signode, mode, env, prefix, templateArgs, symbol): - # type: (addnodes.desc_signature, unicode, Any, unicode, unicode, Symbol) -> None - _verify_description_mode(mode) - identifier = text_type(self) - if mode == 'lastIsName': - signode += addnodes.desc_name(identifier, identifier) - else: - signode += addnodes.desc_addname(identifier, identifier) - -class ASTOperatorLiteral(ASTBase): +class ASTOperatorLiteral(ASTOperator): def __init__(self, identifier): # type: (Any) -> None self.identifier = identifier - def is_anon(self): - return False - - def is_operator(self): - # type: () -> bool - return True - def get_id(self, version): # type: (int) -> unicode if version == 1: @@ -1997,14 +1983,8 @@ class ASTOperatorLiteral(ASTBase): def _stringify(self, transform): return u'operator""' + transform(self.identifier) - def describe_signature(self, signode, mode, env, prefix, templateArgs, symbol): - # type: (addnodes.desc_signature, unicode, Any, unicode, unicode, Symbol) -> None - _verify_description_mode(mode) - identifier = text_type(self) - if mode == 'lastIsName': - signode += addnodes.desc_name(identifier, identifier) - else: - signode += addnodes.desc_addname(identifier, identifier) + +############################################################################################## class ASTTemplateArgConstant(ASTBase): @@ -2070,7 +2050,7 @@ class ASTTemplateArgs(ASTBase): class ASTNestedNameElement(ASTBase): def __init__(self, identOrOp, templateArgs): - # type: (Any, Any) -> None + # type: (Union[ASTIdentifier, ASTOperator], ASTTemplateArgs) -> None self.identOrOp = identOrOp self.templateArgs = templateArgs @@ -2101,7 +2081,7 @@ class ASTNestedNameElement(ASTBase): class ASTNestedName(ASTBase): def __init__(self, names, templates, rooted): - # type: (List[Any], List[bool], bool) -> None + # type: (List[ASTNestedNameElement], List[bool], bool) -> None assert len(names) > 0 self.names = names self.templates = templates @@ -2186,7 +2166,7 @@ class ASTNestedName(ASTBase): if mode == 'lastIsName': dest = addnodes.desc_addname() for i in range(len(names)): - name = names[i] + nne = names[i] template = self.templates[i] if not first: dest += nodes.Text('::') @@ -2194,14 +2174,14 @@ class ASTNestedName(ASTBase): if template: dest += nodes.Text("template ") first = False - if name != '': - if (name.templateArgs and # type: ignore - iTemplateParams < len(templateParams)): + txt_nne = text_type(nne) + if txt_nne != '': + if nne.templateArgs and iTemplateParams < len(templateParams): templateParamsPrefix += text_type(templateParams[iTemplateParams]) iTemplateParams += 1 - name.describe_signature(dest, 'markType', # type: ignore - env, templateParamsPrefix + prefix, symbol) - prefix += text_type(name) + nne.describe_signature(dest, 'markType', + env, templateParamsPrefix + prefix, symbol) + prefix += txt_nne if mode == 'lastIsName': if len(self.names) > 1: dest += addnodes.desc_addname('::', '::') @@ -3621,7 +3601,7 @@ class ASTDeclaration(ASTBase): class ASTNamespace(ASTBase): def __init__(self, nestedName, templatePrefix): - # type: (Any, Any) -> None + # type: (ASTNestedName, ASTTemplateDeclarationPrefix) -> None self.nestedName = nestedName self.templatePrefix = templatePrefix @@ -3646,9 +3626,15 @@ class Symbol(object): else: return object.__setattr__(self, key, value) - def __init__(self, parent, identOrOp, - templateParams, templateArgs, declaration, docname): - # type: (Any, Any, Any, Any, Any, unicode) -> None + def __init__(self, + parent, # type: Symbol + identOrOp, # type: Union[ASTIdentifier, ASTOperator] + templateParams, # type: Any + templateArgs, # type: Any + declaration, # type: ASTDeclaration + docname # type: unicode + ): + # type: (...) -> None self.parent = parent self.identOrOp = identOrOp self.templateParams = templateParams # template @@ -3658,8 +3644,8 @@ class Symbol(object): self.isRedeclaration = False self._assert_invariants() - self._children = [] # type: List[Any] - self._anonChildren = [] # type: List[Any] + self._children = [] # type: List[Symbol] + self._anonChildren = [] # type: List[Symbol] # note: _children includes _anonChildren if self.parent: self.parent._children.append(self) @@ -3697,7 +3683,7 @@ class Symbol(object): declaration=decl, docname=docname) def _fill_empty(self, declaration, docname): - # type: (Any, unicode) -> None + # type: (ASTDeclaration, unicode) -> None self._assert_invariants() assert not self.declaration assert not self.docname @@ -3759,10 +3745,16 @@ class Symbol(object): templates.append(False) return ASTNestedName(names, templates, rooted=False) - def _find_named_symbol(self, identOrOp, templateParams, templateArgs, - templateShorthand, matchSelf, recurseInAnon, - correctPrimaryTemplateArgs): - # type: (Any, Any, Any, Any, bool, bool, bool) -> Symbol + def _find_named_symbol(self, + identOrOp, # type: Union[ASTIdentifier, ASTOperator] + templateParams, # type: Any + templateArgs, # type: ASTTemplateArgs + templateShorthand, # type: bool + matchSelf, # type: bool + recurseInAnon, # type: bool + correctPrimaryTemplateArgs # type: bool + ): + # type: (...) -> Symbol def isSpecialization(): # the names of the template parameters must be given exactly as args @@ -3823,7 +3815,10 @@ class Symbol(object): return None def _add_symbols(self, nestedName, templateDecls, declaration, docname): - # type: (Any, List[Any], Any, unicode) -> Symbol + # type: (ASTNestedName, List[Any], ASTDeclaration, unicode) -> Symbol + # Used for adding a whole path of symbols, where the last may or may not + # be an actual declaration. + # This condition should be checked at the parser level. # Each template argument list must have a template parameter list. # But to declare a template there must be an additional template parameter list. @@ -3919,7 +3914,7 @@ class Symbol(object): return symbol def merge_with(self, other, docnames, env): - # type: (Any, List[unicode], BuildEnvironment) -> None + # type: (Symbol, List[unicode], BuildEnvironment) -> None assert other is not None for otherChild in other._children: ourChild = self._find_named_symbol(identOrOp=otherChild.identOrOp, @@ -3952,7 +3947,7 @@ class Symbol(object): ourChild.merge_with(otherChild, docnames, env) def add_name(self, nestedName, templatePrefix=None): - # type: (unicode, Any) -> Symbol + # type: (ASTNestedName, ASTTemplateDeclarationPrefix) -> Symbol if templatePrefix: templateDecls = templatePrefix.templates else: @@ -3961,7 +3956,7 @@ class Symbol(object): declaration=None, docname=None) def add_declaration(self, declaration, docname): - # type: (Any, unicode) -> Symbol + # type: (ASTDeclaration, unicode) -> Symbol assert declaration assert docname nestedName = declaration.name @@ -3972,7 +3967,7 @@ class Symbol(object): return self._add_symbols(nestedName, templateDecls, declaration, docname) def find_identifier(self, identOrOp, matchSelf, recurseInAnon): - # type: (Any, bool, bool) -> Symbol + # type: (Union[ASTIdentifier, ASTOperator], bool, bool) -> Symbol if matchSelf and self.identOrOp == identOrOp: return self children = self.children_recurse_anon if recurseInAnon else self._children @@ -3982,7 +3977,7 @@ class Symbol(object): return None def direct_lookup(self, key): - # type: (List[Tuple[Any, Any]]) -> Symbol + # type: (List[Tuple[ASTNestedNameElement, Any]]) -> Symbol s = self for name, templateParams in key: identOrOp = name.identOrOp @@ -3999,7 +3994,7 @@ class Symbol(object): def find_name(self, nestedName, templateDecls, typ, templateShorthand, matchSelf, recurseInAnon): - # type: (Any, Any, Any, Any, bool, bool) -> Symbol + # type: (ASTNestedName, List[Any], unicode, bool, bool, bool) -> Symbol # templateShorthand: missing template parameter lists for templates is ok # TODO: unify this with the _add_symbols @@ -4895,7 +4890,7 @@ class DefinitionParser(object): return ASTFallbackExpr(value.strip()) def _parse_operator(self): - # type: () -> Any + # type: () -> ASTOperator self.skip_ws() # adapted from the old code # thank god, a regular operator definition @@ -4991,6 +4986,7 @@ class DefinitionParser(object): else: template = False templates.append(template) + identOrOp = None # type: Union[ASTIdentifier, ASTOperator] if self.skip_word_and_ws('operator'): identOrOp = self._parse_operator() else: @@ -5757,12 +5753,12 @@ class DefinitionParser(object): self.skip_ws() if not self.match(_identifier_re): self.fail("Expected identifier in template introduction list.") - identifier = self.matched_text + txt_identifier = self.matched_text # make sure there isn't a keyword - if identifier in _keywords: + if txt_identifier in _keywords: self.fail("Expected identifier in template introduction list, " - "got keyword: %s" % identifier) - identifier = ASTIdentifier(identifier) # type: ignore + "got keyword: %s" % txt_identifier) + identifier = ASTIdentifier(txt_identifier) params.append(ASTTemplateIntroductionParameter(identifier, parameterPack)) self.skip_ws() From 3348b9255f19ad87fc33bc085d051c527ae8509b Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Mon, 13 Aug 2018 20:38:35 +0200 Subject: [PATCH 155/174] C++, unify symbol lookup algorithms --- sphinx/domains/cpp.py | 248 +++++++++++++++++++++++------------------- 1 file changed, 136 insertions(+), 112 deletions(-) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index b67747609..5acba9d3b 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -3814,64 +3814,136 @@ class Symbol(object): return s return None - def _add_symbols(self, nestedName, templateDecls, declaration, docname): - # type: (ASTNestedName, List[Any], ASTDeclaration, unicode) -> Symbol - # Used for adding a whole path of symbols, where the last may or may not - # be an actual declaration. + def _symbol_lookup( + self, + nestedName, # type: ASTNestedName + templateDecls, # type: List[Any] + onMissingQualifiedSymbol, + # type: Callable[[Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs], Symbol] # NOQA + strictTemplateParamArgLists, # type: bool + ancestorLookupType, # type: unicode + templateShorthand, # type: bool + matchSelf, # type: bool + recurseInAnon, # type: bool + correctPrimaryTemplateArgs # type: bool + ): + # type: (...) -> Tuple[Symbol, Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs] # NOQA + # ancestorLookupType: if not None, specifies the target type of the lookup - # This condition should be checked at the parser level. - # Each template argument list must have a template parameter list. - # But to declare a template there must be an additional template parameter list. - assert(nestedName.num_templates() == len(templateDecls) or - nestedName.num_templates() + 1 == len(templateDecls)) + if strictTemplateParamArgLists: + # Each template argument list must have a template parameter list. + # But to declare a template there must be an additional template parameter list. + assert (nestedName.num_templates() == len(templateDecls) or + nestedName.num_templates() + 1 == len(templateDecls)) + else: + assert len(templateDecls) <= nestedName.num_templates() + 1 + names = nestedName.names + + # find the right starting point for lookup parentSymbol = self if nestedName.rooted: while parentSymbol.parent: parentSymbol = parentSymbol.parent - names = nestedName.names + if ancestorLookupType is not None: + # walk up until we find the first identifier + firstName = names[0] + if not firstName.is_operator(): + while parentSymbol.parent: + if parentSymbol.find_identifier(firstName.identOrOp, + matchSelf=matchSelf, + recurseInAnon=recurseInAnon): + # if we are in the scope of a constructor but wants to + # reference the class we need to walk one extra up + if (len(names) == 1 and ancestorLookupType == 'class' and matchSelf and + parentSymbol.parent and + parentSymbol.parent.identOrOp == firstName.identOrOp): + pass + else: + break + parentSymbol = parentSymbol.parent + + # and now the actual lookup iTemplateDecl = 0 for name in names[:-1]: identOrOp = name.identOrOp templateArgs = name.templateArgs - if templateArgs: - assert iTemplateDecl < len(templateDecls) - templateParams = templateDecls[iTemplateDecl] - iTemplateDecl += 1 + if strictTemplateParamArgLists: + # there must be a parameter list + if templateArgs: + assert iTemplateDecl < len(templateDecls) + templateParams = templateDecls[iTemplateDecl] + iTemplateDecl += 1 + else: + templateParams = None else: - templateParams = None - symbol = parentSymbol._find_named_symbol(identOrOp, - templateParams, - templateArgs, - templateShorthand=False, - matchSelf=False, - recurseInAnon=True, - correctPrimaryTemplateArgs=True) + # take the next template parameter list if there is one + # otherwise it's ok + if templateArgs and iTemplateDecl < len(templateDecls): + templateParams = templateDecls[iTemplateDecl] + iTemplateDecl += 1 + else: + templateParams = None + + symbol = parentSymbol._find_named_symbol( + identOrOp, + templateParams, templateArgs, + templateShorthand=templateShorthand, + matchSelf=matchSelf, + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=correctPrimaryTemplateArgs) if symbol is None: - symbol = Symbol(parent=parentSymbol, identOrOp=identOrOp, - templateParams=templateParams, - templateArgs=templateArgs, declaration=None, - docname=None) + symbol = onMissingQualifiedSymbol(parentSymbol, identOrOp, + templateParams, templateArgs) + if symbol is None: + return None, None, None, None, None + # We have now matched part of a nested name, and need to match more + # so even if we should matchSelf before, we definitely shouldn't + # even more. (see also issue #2666) + matchSelf = False parentSymbol = symbol + + # handle the last name name = names[-1] identOrOp = name.identOrOp templateArgs = name.templateArgs if iTemplateDecl < len(templateDecls): - if iTemplateDecl + 1 != len(templateDecls): - print(text_type(templateDecls)) - print(text_type(nestedName)) assert iTemplateDecl + 1 == len(templateDecls) templateParams = templateDecls[iTemplateDecl] else: assert iTemplateDecl == len(templateDecls) templateParams = None + symbol = parentSymbol._find_named_symbol(identOrOp, - templateParams, - templateArgs, - templateShorthand=False, - matchSelf=False, - recurseInAnon=True, + templateParams, templateArgs, + templateShorthand=templateShorthand, + matchSelf=matchSelf, + recurseInAnon=recurseInAnon, correctPrimaryTemplateArgs=False) + return symbol, parentSymbol, identOrOp, templateParams, templateArgs + + def _add_symbols(self, nestedName, templateDecls, declaration, docname): + # type: (ASTNestedName, List[Any], ASTDeclaration, unicode) -> Symbol + # Used for adding a whole path of symbols, where the last may or may not + # be an actual declaration. + + def onMissingQualifiedSymbol(parentSymbol, identOrOp, templateParams, templateArgs): + # type: (Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs) -> Symbol + return Symbol(parent=parentSymbol, identOrOp=identOrOp, + templateParams=templateParams, + templateArgs=templateArgs, declaration=None, + docname=None) + + symbol, parentSymbol, identOrOp, templateParams, templateArgs = \ + self._symbol_lookup(nestedName, templateDecls, + onMissingQualifiedSymbol, + strictTemplateParamArgLists=True, + ancestorLookupType=None, + templateShorthand=False, + matchSelf=False, + recurseInAnon=True, + correctPrimaryTemplateArgs=True) + if symbol: if not declaration: # good, just a scope creation @@ -3997,85 +4069,37 @@ class Symbol(object): # type: (ASTNestedName, List[Any], unicode, bool, bool, bool) -> Symbol # templateShorthand: missing template parameter lists for templates is ok - # TODO: unify this with the _add_symbols - # This condition should be checked at the parser level. - assert len(templateDecls) <= nestedName.num_templates() + 1 - parentSymbol = self - if nestedName.rooted: - while parentSymbol.parent: - parentSymbol = parentSymbol.parent - names = nestedName.names + def onMissingQualifiedSymbol(parentSymbol, identOrOp, templateParams, templateArgs): + # type: (Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs) -> Symbol + # TODO: Maybe search without template args? + # Though, the correctPrimaryTemplateArgs does + # that for primary templates. + # Is there another case where it would be good? + return None - # walk up until we find the first identifier - firstName = names[0] - if not firstName.is_operator(): - while parentSymbol.parent: - if parentSymbol.find_identifier(firstName.identOrOp, - matchSelf=matchSelf, - recurseInAnon=recurseInAnon): - # if we are in the scope of a constructor but wants to reference the class - # we need to walk one extra up - if (len(names) == 1 and typ == 'class' and matchSelf and - parentSymbol.parent and - parentSymbol.parent.identOrOp == firstName.identOrOp): - pass - else: - break - parentSymbol = parentSymbol.parent - iTemplateDecl = 0 - for iName in range(len(names)): - name = names[iName] - if iName + 1 == len(names): - identOrOp = name.identOrOp - templateArgs = name.templateArgs - if iTemplateDecl < len(templateDecls): - assert iTemplateDecl + 1 == len(templateDecls) - templateParams = templateDecls[iTemplateDecl] - else: - assert iTemplateDecl == len(templateDecls) - templateParams = None - symbol = parentSymbol._find_named_symbol(identOrOp, - templateParams, templateArgs, - templateShorthand=templateShorthand, - matchSelf=matchSelf, - recurseInAnon=recurseInAnon, - correctPrimaryTemplateArgs=False) - if symbol is not None: - return symbol - # try without template params and args - symbol = parentSymbol._find_named_symbol(identOrOp, - None, None, - templateShorthand=templateShorthand, - matchSelf=matchSelf, - recurseInAnon=recurseInAnon, - correctPrimaryTemplateArgs=False) - return symbol - else: - identOrOp = name.identOrOp - templateArgs = name.templateArgs - if templateArgs and iTemplateDecl < len(templateDecls): - templateParams = templateDecls[iTemplateDecl] - iTemplateDecl += 1 - else: - templateParams = None - symbol = parentSymbol._find_named_symbol(identOrOp, - templateParams, templateArgs, - templateShorthand=templateShorthand, - matchSelf=matchSelf, - recurseInAnon=recurseInAnon, - correctPrimaryTemplateArgs=True) - if symbol is None: - # TODO: Maybe search without template args? - # Though, the correctPrimaryTemplateArgs above does - # that for primary templates. - # Is there another case where it would be good? - return None - # We have now matched part of a nested name, and need to match more - # so even if we should matchSelf before, we definitely shouldn't - # even more. (see also issue #2666) - matchSelf = False - parentSymbol = symbol - assert False # should have returned in the loop + symbol, parentSymbol, identOrOp, templateParams, templateArgs = \ + self._symbol_lookup(nestedName, templateDecls, + onMissingQualifiedSymbol, + strictTemplateParamArgLists=False, + ancestorLookupType=typ, + templateShorthand=templateShorthand, + matchSelf=matchSelf, + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=False) + + if symbol is not None: + return symbol + # if it was a part of the qualification that could not be found: + if parentSymbol is None: + return None + # try without template params and args + symbol = parentSymbol._find_named_symbol(identOrOp, + None, None, + templateShorthand=templateShorthand, + matchSelf=matchSelf, + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=False) + return symbol def to_string(self, indent): # type: (int) -> unicode From 1c035d72038f5429566feeda002d3cf05f8e9a54 Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Tue, 14 Aug 2018 23:54:50 +0200 Subject: [PATCH 156/174] C++, add support for overload-specific references. The "any" and "func" roles now accepts full function declarations. Fixes #1552 --- CHANGES | 18 +- doc/usage/restructuredtext/domains.rst | 42 ++- sphinx/domains/cpp.py | 357 ++++++++++++++++--------- 3 files changed, 282 insertions(+), 135 deletions(-) diff --git a/CHANGES b/CHANGES index d9b28c7d3..647c3b188 100644 --- a/CHANGES +++ b/CHANGES @@ -167,13 +167,17 @@ Features added * #4785: napoleon: Add strings to translation file for localisation * #4927: Display a warning when invalid values are passed to linenothreshold option of highlight directive -* C++, add a ``cpp:texpr`` role as a sibling to ``cpp:expr``. -* C++, add support for unions. -* C++, add support for anonymous entities using names staring with ``@``. - Fixes #3593 and #2683. -* #5147: C++, add support for (most) character literals. -* C++, cross-referencing entities inside primary templates is supported, - and now properly documented. +* C++: + + - Add a ``cpp:texpr`` role as a sibling to ``cpp:expr``. + - Add support for unions. + - #3593, #2683: add support for anonymous entities using names staring with ``@``. + - #5147: add support for (most) character literals. + - Cross-referencing entities inside primary templates is supported, + and now properly documented. + - #1552: add new cross-referencing format for ``cpp:any`` and ``cpp:func`` roles, + for referencing specific function overloads. + * #3606: MathJax should be loaded with async attribute * html: Output ``canonical_url`` metadata if :confval:`html_baseurl` set (refs: #4193) diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst index afc8e8d39..e77075c1a 100644 --- a/doc/usage/restructuredtext/domains.rst +++ b/doc/usage/restructuredtext/domains.rst @@ -1005,20 +1005,46 @@ These roles link to the given declaration types: When a custom title is not needed it may be useful to use the roles for inline expressions, :rst:role:`cpp:expr` and :rst:role:`cpp:texpr`, where angle brackets do not need escaping. -.. admonition:: Note on References to Overloaded Functions - - It is currently impossible to link to a specific version of an overloaded - function. Currently the C++ domain is the first domain that has basic - support for overloaded functions and until there is more data for comparison - we don't want to select a bad syntax to reference a specific overload. - Currently Sphinx will link to the first overloaded version of the function. - Declarations without template parameters and template arguments ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For linking to non-templated declarations the name must be a nested name, e.g., ``f`` or ``MyClass::f``. + +Overloaded (member) functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When a (member) function is referenced using just its name, the reference +will point to an arbitrary matching overload. +The :rst:role:`cpp:any` and :rst:role:`cpp:func` roles will an alternative +format, which simply is a complete function declaration. +This will resolve to the exact matching overload. +As example, consider the following class declaration: + +.. cpp:namespace-push:: overload_example +.. cpp:class:: C + + .. cpp:function:: void f(double d) const + .. cpp:function:: void f(double d) + .. cpp:function:: void f(int i) + .. cpp:function:: void f() + +References using the :rst:role:`cpp:func` role: + +- Arbitrary overload: ``C::f``, :cpp:func:`C::f` +- Also arbitrary overload: ``C::f()``, :cpp:func:`C::f()` +- Specific overload: ``void C::f()``, :cpp:func:`void C::f()` +- Specific overload: ``void C::f(int)``, :cpp:func:`void C::f(int)` +- Specific overload: ``void C::f(double)``, :cpp:func:`void C::f(double)` +- Specific overload: ``void C::f(double) const``, :cpp:func:`void C::f(double) const` + +Note that the :confval:`add_function_parentheses` configuration variable +does not influence specific overload references. + +.. cpp:namespace-pop:: + + Templated declarations ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 5acba9d3b..aeeaa2122 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -622,20 +622,6 @@ class ASTBase(UnicodeMixin): """Clone a definition expression node.""" return deepcopy(self) - def get_name(self): - # type: () -> unicode - """Return the name. - - Returns either `None` or a node with a name you might call - :meth:`split_owner` on. - """ - raise NotImplementedError(repr(self)) - - def prefix_nested_name(self, prefix): - # type: (unicode) -> unicode - """Prefix a name node (a node returned by :meth:`get_name`).""" - raise NotImplementedError(repr(self)) - def _stringify(self, transform): # type: (Callable[[Any], unicode]) -> unicode raise NotImplementedError(repr(self)) @@ -1875,7 +1861,7 @@ class ASTTemplateIntroduction(ASTBase): class ASTTemplateDeclarationPrefix(ASTBase): def __init__(self, templates): # type: (List[Any]) -> None - # template is None means it's an explicit instantiation of a variable + # templates is None means it's an explicit instantiation of a variable self.templates = templates def get_id(self, version): @@ -3606,6 +3592,16 @@ class ASTNamespace(ASTBase): self.templatePrefix = templatePrefix +class SymbolLookupResult(object): + def __init__(self, symbols, parentSymbol, identOrOp, templateParams, templateArgs): + # type: (Iterator[Symbol], Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs) -> None # NOQA + self.symbols = symbols + self.parentSymbol = parentSymbol + self.identOrOp = identOrOp + self.templateParams = templateParams + self.templateArgs = templateArgs + + class Symbol(object): def _assert_invariants(self): # type: () -> None @@ -3644,6 +3640,7 @@ class Symbol(object): self.isRedeclaration = False self._assert_invariants() + # Remember to modify Symbol.remove if modifications to the parent change. self._children = [] # type: List[Symbol] self._anonChildren = [] # type: List[Symbol] # note: _children includes _anonChildren @@ -3682,6 +3679,13 @@ class Symbol(object): templateParams=None, templateArgs=None, declaration=decl, docname=docname) + def remove(self): + if self.parent is None: + return + assert self in self.parent._children + self.parent._children.remove(self) + self.parent = None + def _fill_empty(self, declaration, docname): # type: (ASTDeclaration, unicode) -> None self._assert_invariants() @@ -3745,16 +3749,35 @@ class Symbol(object): templates.append(False) return ASTNestedName(names, templates, rooted=False) - def _find_named_symbol(self, - identOrOp, # type: Union[ASTIdentifier, ASTOperator] - templateParams, # type: Any - templateArgs, # type: ASTTemplateArgs - templateShorthand, # type: bool - matchSelf, # type: bool - recurseInAnon, # type: bool - correctPrimaryTemplateArgs # type: bool - ): + def _find_first_named_symbol( + self, + identOrOp, # type: Union[ASTIdentifier, ASTOperator] + templateParams, # type: Any + templateArgs, # type: ASTTemplateArgs + templateShorthand, # type: bool + matchSelf, # type: bool + recurseInAnon, # type: bool + correctPrimaryTemplateArgs # type: bool + ): # NOQA # type: (...) -> Symbol + res = self._find_named_symbols(identOrOp, templateParams, templateArgs, + templateShorthand, matchSelf, recurseInAnon, + correctPrimaryTemplateArgs) + try: + return next(res) + except StopIteration: + return None + + def _find_named_symbols(self, + identOrOp, # type: Union[ASTIdentifier, ASTOperator] + templateParams, # type: Any + templateArgs, # type: ASTTemplateArgs + templateShorthand, # type: bool + matchSelf, # type: bool + recurseInAnon, # type: bool + correctPrimaryTemplateArgs # type: bool + ): + # type: (...) -> Iterator[Symbol] def isSpecialization(): # the names of the template parameters must be given exactly as args @@ -3807,12 +3830,11 @@ class Symbol(object): return False return True if matchSelf and matches(self): - return self + yield self children = self.children_recurse_anon if recurseInAnon else self._children for s in children: if matches(s): - return s - return None + yield s def _symbol_lookup( self, @@ -3827,7 +3849,7 @@ class Symbol(object): recurseInAnon, # type: bool correctPrimaryTemplateArgs # type: bool ): - # type: (...) -> Tuple[Symbol, Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs] # NOQA + # type: (...) -> SymbolLookupResult # ancestorLookupType: if not None, specifies the target type of the lookup if strictTemplateParamArgLists: @@ -3885,7 +3907,7 @@ class Symbol(object): else: templateParams = None - symbol = parentSymbol._find_named_symbol( + symbol = parentSymbol._find_first_named_symbol( identOrOp, templateParams, templateArgs, templateShorthand=templateShorthand, @@ -3896,7 +3918,7 @@ class Symbol(object): symbol = onMissingQualifiedSymbol(parentSymbol, identOrOp, templateParams, templateArgs) if symbol is None: - return None, None, None, None, None + return None # We have now matched part of a nested name, and need to match more # so even if we should matchSelf before, we definitely shouldn't # even more. (see also issue #2666) @@ -3914,13 +3936,12 @@ class Symbol(object): assert iTemplateDecl == len(templateDecls) templateParams = None - symbol = parentSymbol._find_named_symbol(identOrOp, - templateParams, templateArgs, - templateShorthand=templateShorthand, - matchSelf=matchSelf, - recurseInAnon=recurseInAnon, - correctPrimaryTemplateArgs=False) - return symbol, parentSymbol, identOrOp, templateParams, templateArgs + symbols = parentSymbol._find_named_symbols( + identOrOp, templateParams, templateArgs, + templateShorthand=templateShorthand, matchSelf=matchSelf, + recurseInAnon=recurseInAnon, correctPrimaryTemplateArgs=False) + return SymbolLookupResult(symbols, parentSymbol, + identOrOp, templateParams, templateArgs) def _add_symbols(self, nestedName, templateDecls, declaration, docname): # type: (ASTNestedName, List[Any], ASTDeclaration, unicode) -> Symbol @@ -3934,15 +3955,20 @@ class Symbol(object): templateArgs=templateArgs, declaration=None, docname=None) - symbol, parentSymbol, identOrOp, templateParams, templateArgs = \ - self._symbol_lookup(nestedName, templateDecls, - onMissingQualifiedSymbol, - strictTemplateParamArgLists=True, - ancestorLookupType=None, - templateShorthand=False, - matchSelf=False, - recurseInAnon=True, - correctPrimaryTemplateArgs=True) + lookupResult = self._symbol_lookup(nestedName, templateDecls, + onMissingQualifiedSymbol, + strictTemplateParamArgLists=True, + ancestorLookupType=None, + templateShorthand=False, + matchSelf=False, + recurseInAnon=True, + correctPrimaryTemplateArgs=True) + assert lookupResult is not None # we create symbols all the way, so that can't happen + # TODO: actually do the iteration over results, though let's find a test case first + try: + symbol = next(lookupResult.symbols) + except StopIteration: + symbol = None if symbol: if not declaration: @@ -3958,9 +3984,10 @@ class Symbol(object): return symbol # It may simply be a function overload, so let's compare ids. isRedeclaration = True - candSymbol = Symbol(parent=parentSymbol, identOrOp=identOrOp, - templateParams=templateParams, - templateArgs=templateArgs, + candSymbol = Symbol(parent=lookupResult.parentSymbol, + identOrOp=lookupResult.identOrOp, + templateParams=lookupResult.templateParams, + templateArgs=lookupResult.templateArgs, declaration=declaration, docname=docname) if declaration.objectType == "function": @@ -3978,9 +4005,10 @@ class Symbol(object): candSymbol.isRedeclaration = True raise _DuplicateSymbolError(symbol, declaration) else: - symbol = Symbol(parent=parentSymbol, identOrOp=identOrOp, - templateParams=templateParams, - templateArgs=templateArgs, + symbol = Symbol(parent=lookupResult.parentSymbol, + identOrOp=lookupResult.identOrOp, + templateParams=lookupResult.templateParams, + templateArgs=lookupResult.templateArgs, declaration=declaration, docname=docname) return symbol @@ -3989,13 +4017,12 @@ class Symbol(object): # type: (Symbol, List[unicode], BuildEnvironment) -> None assert other is not None for otherChild in other._children: - ourChild = self._find_named_symbol(identOrOp=otherChild.identOrOp, - templateParams=otherChild.templateParams, - templateArgs=otherChild.templateArgs, - templateShorthand=False, - matchSelf=False, - recurseInAnon=False, - correctPrimaryTemplateArgs=False) + ourChild = self._find_first_named_symbol( + identOrOp=otherChild.identOrOp, + templateParams=otherChild.templateParams, + templateArgs=otherChild.templateArgs, + templateShorthand=False, matchSelf=False, + recurseInAnon=False, correctPrimaryTemplateArgs=False) if ourChild is None: # TODO: hmm, should we prune by docnames? self._children.append(otherChild) @@ -4054,12 +4081,12 @@ class Symbol(object): for name, templateParams in key: identOrOp = name.identOrOp templateArgs = name.templateArgs - s = s._find_named_symbol(identOrOp, - templateParams, templateArgs, - templateShorthand=False, - matchSelf=False, - recurseInAnon=False, - correctPrimaryTemplateArgs=False) + s = s._find_first_named_symbol(identOrOp, + templateParams, templateArgs, + templateShorthand=False, + matchSelf=False, + recurseInAnon=False, + correctPrimaryTemplateArgs=False) if not s: return None return s @@ -4077,30 +4104,76 @@ class Symbol(object): # Is there another case where it would be good? return None - symbol, parentSymbol, identOrOp, templateParams, templateArgs = \ - self._symbol_lookup(nestedName, templateDecls, - onMissingQualifiedSymbol, - strictTemplateParamArgLists=False, - ancestorLookupType=typ, - templateShorthand=templateShorthand, - matchSelf=matchSelf, - recurseInAnon=recurseInAnon, - correctPrimaryTemplateArgs=False) - - if symbol is not None: - return symbol - # if it was a part of the qualification that could not be found: - if parentSymbol is None: + lookupResult = self._symbol_lookup(nestedName, templateDecls, + onMissingQualifiedSymbol, + strictTemplateParamArgLists=False, + ancestorLookupType=typ, + templateShorthand=templateShorthand, + matchSelf=matchSelf, + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=False) + if lookupResult is None: + # if it was a part of the qualification that could not be found return None + + # TODO: hmm, what if multiple symbols match? + try: + return next(lookupResult.symbols) + except StopIteration: + pass + # try without template params and args - symbol = parentSymbol._find_named_symbol(identOrOp, - None, None, - templateShorthand=templateShorthand, - matchSelf=matchSelf, - recurseInAnon=recurseInAnon, - correctPrimaryTemplateArgs=False) + symbol = lookupResult.parentSymbol._find_first_named_symbol( + lookupResult.identOrOp, None, None, + templateShorthand=templateShorthand, matchSelf=matchSelf, + recurseInAnon=recurseInAnon, correctPrimaryTemplateArgs=False) return symbol + def find_declaration(self, declaration, typ, templateShorthand, + matchSelf, recurseInAnon): + # type: (ASTDeclaration, unicode, bool, bool, bool) -> Symbol + # templateShorthand: missing template parameter lists for templates is ok + nestedName = declaration.name + if declaration.templatePrefix: + templateDecls = declaration.templatePrefix.templates + else: + templateDecls = [] + + def onMissingQualifiedSymbol(parentSymbol, identOrOp, templateParams, templateArgs): + # type: (Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs) -> Symbol + return None + + lookupResult = self._symbol_lookup(nestedName, templateDecls, + onMissingQualifiedSymbol, + strictTemplateParamArgLists=False, + ancestorLookupType=typ, + templateShorthand=templateShorthand, + matchSelf=matchSelf, + recurseInAnon=recurseInAnon, + correctPrimaryTemplateArgs=False) + + if lookupResult is None: + return None + + symbols = list(lookupResult.symbols) + if len(symbols) == 0: + return None + + querySymbol = Symbol(parent=lookupResult.parentSymbol, + identOrOp=lookupResult.identOrOp, + templateParams=lookupResult.templateParams, + templateArgs=lookupResult.templateArgs, + declaration=declaration, + docname='fakeDocnameForQuery') + queryId = declaration.get_newest_id() + for symbol in symbols: + candId = symbol.declaration.get_newest_id() + if candId == queryId: + querySymbol.remove() + return symbol + querySymbol.remove() + return None + def to_string(self, indent): # type: (int) -> unicode res = ['\t' * indent] # type: List[unicode] @@ -5825,9 +5898,13 @@ class DefinitionParser(object): else: return ASTTemplateDeclarationPrefix(templates) - def _check_template_consistency(self, nestedName, templatePrefix, - fullSpecShorthand, isMember=False): - # type: (Any, Any, Any, bool) -> ASTTemplateDeclarationPrefix + def _check_template_consistency(self, + nestedName, # type: ASTNestedName + templatePrefix, # type: ASTTemplateDeclarationPrefix + fullSpecShorthand, # type: bool + isMember=False # type: bool + ): + # type: (...) -> ASTTemplateDeclarationPrefix numArgs = nestedName.num_templates() isMemberInstantiation = False if not templatePrefix: @@ -5931,17 +6008,33 @@ class DefinitionParser(object): return res def parse_xref_object(self): - # type: () -> ASTNamespace - templatePrefix = self._parse_template_declaration_prefix(objectType="xref") - name = self._parse_nested_name() - # if there are '()' left, just skip them - self.skip_ws() - self.skip_string('()') - templatePrefix = self._check_template_consistency(name, templatePrefix, - fullSpecShorthand=True) - res = ASTNamespace(name, templatePrefix) - res.objectType = 'xref' # type: ignore - return res + # type: () -> Tuple[Any, bool] + pos = self.pos + try: + templatePrefix = self._parse_template_declaration_prefix(objectType="xref") + name = self._parse_nested_name() + # if there are '()' left, just skip them + self.skip_ws() + self.skip_string('()') + templatePrefix = self._check_template_consistency(name, templatePrefix, + fullSpecShorthand=True) + res1 = ASTNamespace(name, templatePrefix) + res1.objectType = 'xref' # type: ignore + return res1, True + except DefinitionError as e1: + try: + self.pos = pos + res2 = self.parse_declaration('function') + # if there are '()' left, just skip them + self.skip_ws() + self.skip_string('()') + return res2, False + except DefinitionError as e2: + errs = [] + errs.append((e1, "If shorthand ref")) + errs.append((e2, "If full function ref")) + msg = "Error in cross-reference." + raise self._make_multi_error(errs, msg) def parse_expression(self): pos = self.pos @@ -6542,7 +6635,7 @@ class CPPDomain(Domain): target += '()' parser = DefinitionParser(target, warner, env.config) try: - ast = parser.parse_xref_object() + ast, isShorthand = parser.parse_xref_object() parser.assert_end() except DefinitionError as e: def findWarning(e): # as arg to stop flake8 from complaining @@ -6573,14 +6666,21 @@ class CPPDomain(Domain): else: parentSymbol = rootSymbol - name = ast.nestedName - if ast.templatePrefix: - templateDecls = ast.templatePrefix.templates + if isShorthand: + ns = ast # type: ASTNamespace + name = ns.nestedName + if ns.templatePrefix: + templateDecls = ns.templatePrefix.templates + else: + templateDecls = [] + s = parentSymbol.find_name(name, templateDecls, typ, + templateShorthand=True, + matchSelf=True, recurseInAnon=True) else: - templateDecls = [] - s = parentSymbol.find_name(name, templateDecls, typ, - templateShorthand=True, - matchSelf=True, recurseInAnon=True) + decl = ast # type: ASTDeclaration + s = parentSymbol.find_declaration(decl, typ, + templateShorthand=True, + matchSelf=True, recurseInAnon=True) if s is None or s.declaration is None: txtName = text_type(name) if txtName.startswith('std::') or txtName == 'std': @@ -6609,8 +6709,11 @@ class CPPDomain(Domain): s.get_full_nested_name())) declaration = s.declaration - fullNestedName = s.get_full_nested_name() - displayName = fullNestedName.get_display_string().lstrip(':') + if isShorthand: + fullNestedName = s.get_full_nested_name() + displayName = fullNestedName.get_display_string().lstrip(':') + else: + displayName = decl.get_display_string() docname = s.docname assert docname @@ -6622,19 +6725,33 @@ class CPPDomain(Domain): # are requested. Then the Sphinx machinery will add another pair. # Also, if it's an 'any' ref that resolves to a function, we need to add # parens as well. + # However, if it's a non-shorthand function ref, for a function that + # takes no arguments, then we may need to add parens again as well. addParen = 0 if not node.get('refexplicit', False) and declaration.objectType == 'function': - # this is just the normal haxing for 'any' roles - if env.config.add_function_parentheses and typ == 'any': - addParen += 1 - # and now this stuff for operator() - if (env.config.add_function_parentheses and typ == 'function' and - title.endswith('operator()')): - addParen += 1 - if ((typ == 'any' or typ == 'function') and - title.endswith('operator') and - displayName.endswith('operator()')): - addParen += 1 + if isShorthand: + # this is just the normal haxing for 'any' roles + if env.config.add_function_parentheses and typ == 'any': + addParen += 1 + # and now this stuff for operator() + if (env.config.add_function_parentheses and typ == 'function' and + title.endswith('operator()')): + addParen += 1 + if ((typ == 'any' or typ == 'function') and + title.endswith('operator') and + displayName.endswith('operator()')): + addParen += 1 + else: + # our job here is to essentially nullify add_function_parentheses + if env.config.add_function_parentheses: + if typ == 'any' and displayName.endswith('()'): + addParen += 1 + elif typ == 'function': + if title.endswith('()') and not displayName.endswith('()'): + title = title[:-2] + else: + if displayName.endswith('()'): + addParen += 1 if addParen > 0: title += '()' * addParen # and reconstruct the title again From 3d9e2cf8312ed5d86a9838fe7b9485c09fd0a922 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 18 Aug 2018 17:40:38 +0900 Subject: [PATCH 157/174] Add autodoc_default_options --- CHANGES | 4 +- doc/extdev/index.rst | 5 +++ doc/usage/extensions/autodoc.rst | 64 ++++++++++++++++++-------------- sphinx/ext/autodoc/__init__.py | 26 +++++-------- sphinx/ext/autodoc/directive.py | 4 +- tests/test_autodoc.py | 59 +++++++++++++---------------- 6 files changed, 80 insertions(+), 82 deletions(-) diff --git a/CHANGES b/CHANGES index d9b28c7d3..33b0dadad 100644 --- a/CHANGES +++ b/CHANGES @@ -58,6 +58,7 @@ Deprecated ---------- * :confval:`source_parsers` is deprecated +* :confval:`autodoc_default_flags` is deprecated * quickstart: ``--epub`` option becomes default, so it is deprecated * Drop function based directive support. For now, Sphinx only supports class based directives. @@ -198,7 +199,8 @@ Features added builder * #5273: doctest: Skip doctest conditionally * #5306: autodoc: emit a warning for invalid typehints -* #5215: autodoc: :confval:`autodoc_default_flags` accepts option values as dict +* #4075, #5215: autodoc: Add :confval:`autodoc_default_options` which accepts + option values as dict Bugs fixed ---------- diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 0fa4db260..6e8bdd41d 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -131,6 +131,11 @@ The following is a list of deprecated interface. - 4.0 - :meth:`~sphinx.application.Sphinx.add_js_file()` + * - :confval:`autodoc_default_flags` + - 1.8 + - 4.0 + - :confval:`autodoc_default_options` + * - ``sphinx.directives.other.VersionChanges`` - 1.8 - 3.0 diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 2b2a5f3ac..97ac51903 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -114,8 +114,17 @@ inserting them into the page source under a suitable :rst:dir:`py:module`, .. autoclass:: Noodle :members: eat, slurp - * If you want to make the ``members`` option (or other flag options described - below) the default, see :confval:`autodoc_default_flags`. + * If you want to make the ``members`` option (or other options described + below) the default, see :confval:`autodoc_default_options`. + + .. tip:: + + You can use a negated form, :samp:`'no-{flag}'`, as an option of + autodoc directive, to disable it temporarily. For example:: + + .. automodule:: foo + :no-undoc-members: + * Members without docstrings will be left out, unless you give the ``undoc-members`` flag option:: @@ -344,35 +353,34 @@ There are also new config values that you can set: ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and ``'exclude-members'``. - If you set one of these flags in this config value, you can use a negated - form, :samp:`'no-{flag}'`, in an autodoc directive, to disable it once. - For example, if ``autodoc_default_flags`` is set to ``['members', - 'undoc-members']``, and you write a directive like this:: - - .. automodule:: foo - :no-undoc-members: - - the directive will be interpreted as if only ``:members:`` was given. - - You can also set `autodoc_default_flags` to a dictionary, mapping option - names to the values which can used in .rst files. For example:: - - autodoc_default_flags = { - 'members': 'var1, var2', - 'member-order': 'bysource', - 'special-members': '__init__', - 'undoc-members': None, - 'exclude-members': '__weakref__' - } - - Setting ``None`` is equivalent to giving the option name in the list format - (i.e. it means "yes/true/on"). - .. versionadded:: 1.0 - .. versionchanged:: 1.8 + .. deprecated:: 1.8 - Specifying in dictionary format added. + Integrated into :confval:`autodoc_default_options`. + +.. confval:: autodoc_default_options + + The default options for autodoc directives. They are applied to all autodoc + directives automatically. It must be a dictionally which maps option names + to the values. For example:: + + autodoc_default_options = { + 'members': 'var1, var2', + 'member-order': 'bysource', + 'special-members': '__init__', + 'undoc-members': None, + 'exclude-members': '__weakref__' + } + + Setting ``None`` is equivalent to giving the option name in the list format + (i.e. it means "yes/true/on"). + + The supported options are ``'members'``, ``'undoc-members'``, + ``'private-members'``, ``'special-members'``, ``'inherited-members'``, + ``'show-inheritance'``, ``'ignore-module-all'`` and ``'exclude-members'``. + + .. versionadded:: 1.8 .. confval:: autodoc_docstring_signature diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 6671df579..fc0377a8c 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1535,33 +1535,24 @@ def autodoc_attrgetter(app, obj, name, *defargs): return safe_getattr(obj, name, *defargs) -def convert_autodoc_default_flags(app, config): +def merge_autodoc_default_flags(app, config): # type: (Sphinx, Config) -> None - """This converts the old list-of-flags (strings) to a dict of Nones.""" - if isinstance(config.autodoc_default_flags, dict): - # Already new-style + """This merges the autodoc_default_flags to autodoc_default_options.""" + if not config.autodoc_default_flags: return - elif not isinstance(config.autodoc_default_flags, list): - # Not old-style list - logger.error( - __("autodoc_default_flags is invalid type %r"), - config.autodoc_default_flags.__class__.__name__ - ) - return + logger.warning(__('autodoc_default_flags is now deprecated. ' + 'Please use autodoc_default_options instead.')) - autodoc_default_flags = {} # type: Dict[unicode, Any] for option in config.autodoc_default_flags: if isinstance(option, string_types): - autodoc_default_flags[option] = None + config.autodoc_default_options[option] = None else: logger.warning( __("Ignoring invalid option in autodoc_default_flags: %r"), option ) - config.autodoc_default_flags = autodoc_default_flags # type: ignore - def setup(app): # type: (Sphinx) -> Dict[unicode, Any] @@ -1576,7 +1567,8 @@ def setup(app): app.add_config_value('autoclass_content', 'class', True) app.add_config_value('autodoc_member_order', 'alphabetic', True) - app.add_config_value('autodoc_default_flags', {}, True, Any) + app.add_config_value('autodoc_default_flags', [], True) + app.add_config_value('autodoc_default_options', {}, True) app.add_config_value('autodoc_docstring_signature', True, True) app.add_config_value('autodoc_mock_imports', [], True) app.add_config_value('autodoc_warningiserror', True, True) @@ -1585,6 +1577,6 @@ def setup(app): app.add_event('autodoc-process-signature') app.add_event('autodoc-skip-member') - app.connect('config-inited', convert_autodoc_default_flags) + app.connect('config-inited', merge_autodoc_default_flags) return {'version': sphinx.__display_version__, 'parallel_read_safe': True} diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py index 34f7567d4..3a3434fc8 100644 --- a/sphinx/ext/autodoc/directive.py +++ b/sphinx/ext/autodoc/directive.py @@ -67,8 +67,8 @@ def process_documenter_options(documenter, config, options): continue else: negated = options.pop('no-' + name, True) is None - if name in config.autodoc_default_flags and not negated: - options[name] = config.autodoc_default_flags[name] + if name in config.autodoc_default_options and not negated: + options[name] = config.autodoc_default_options[name] return Options(assemble_option_dict(options.items(), documenter.option_spec)) diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 0cd543ad7..26a47987f 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -21,7 +21,7 @@ from six import PY3 from sphinx.ext.autodoc import ( AutoDirective, ModuleLevelDocumenter, cut_lines, between, ALL, - convert_autodoc_default_flags + merge_autodoc_default_flags ) from sphinx.ext.autodoc.directive import DocumenterBridge, process_documenter_options from sphinx.testing.util import SphinxTestApp, Struct # NOQA @@ -1418,35 +1418,26 @@ def test_partialmethod(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') -def test_autodoc_default_flags__as_list__converted(app): - orig = [ - 'members', - 'undoc-members', - ('skipped', 1, 2), - {'also': 'skipped'}, - ] - expected = { - 'members': None, - 'undoc-members': None, - } - app.config.autodoc_default_flags = orig - convert_autodoc_default_flags(app, app.config) - assert app.config.autodoc_default_flags == expected +def test_merge_autodoc_default_flags1(app): + app.config.autodoc_default_flags = ['members', 'undoc-members'] + merge_autodoc_default_flags(app, app.config) + assert app.config.autodoc_default_options == {'members': None, + 'undoc-members': None} @pytest.mark.sphinx('html', testroot='ext-autodoc') -def test_autodoc_default_flags__as_dict__no_conversion(app): - orig = { - 'members': 'this,that,other', - 'undoc-members': None, - } - app.config.autodoc_default_flags = orig - convert_autodoc_default_flags(app, app.config) - assert app.config.autodoc_default_flags == orig +def test_merge_autodoc_default_flags2(app): + app.config.autodoc_default_flags = ['members', 'undoc-members'] + app.config.autodoc_default_options = {'members': 'this,that,order', + 'inherited-members': 'this'} + merge_autodoc_default_flags(app, app.config) + assert app.config.autodoc_default_options == {'members': None, + 'undoc-members': None, + 'inherited-members': 'this'} @pytest.mark.sphinx('html', testroot='ext-autodoc') -def test_autodoc_default_flags__with_flags(app): +def test_autodoc_default_options(app): # no settings actual = do_autodoc(app, 'class', 'target.EnumCls') assert ' .. py:attribute:: EnumCls.val1' not in actual @@ -1455,13 +1446,13 @@ def test_autodoc_default_flags__with_flags(app): assert ' .. py:method:: target.CustomIter' not in actual # with :members: - app.config.autodoc_default_flags = {'members': None} + app.config.autodoc_default_options = {'members': None} actual = do_autodoc(app, 'class', 'target.EnumCls') assert ' .. py:attribute:: EnumCls.val1' in actual assert ' .. py:attribute:: EnumCls.val4' not in actual # with :members: and :undoc-members: - app.config.autodoc_default_flags = { + app.config.autodoc_default_options = { 'members': None, 'undoc-members': None, } @@ -1471,7 +1462,7 @@ def test_autodoc_default_flags__with_flags(app): # with :special-members: # Note that :members: must be *on* for :special-members: to work. - app.config.autodoc_default_flags = { + app.config.autodoc_default_options = { 'members': None, 'special-members': None } @@ -1487,14 +1478,14 @@ def test_autodoc_default_flags__with_flags(app): # :exclude-members: None - has no effect. Unlike :members:, # :special-members:, etc. where None == "include all", here None means # "no/false/off". - app.config.autodoc_default_flags = { + app.config.autodoc_default_options = { 'members': None, 'exclude-members': None, } actual = do_autodoc(app, 'class', 'target.EnumCls') assert ' .. py:attribute:: EnumCls.val1' in actual assert ' .. py:attribute:: EnumCls.val4' not in actual - app.config.autodoc_default_flags = { + app.config.autodoc_default_options = { 'members': None, 'special-members': None, 'exclude-members': None, @@ -1512,9 +1503,9 @@ def test_autodoc_default_flags__with_flags(app): @pytest.mark.sphinx('html', testroot='ext-autodoc') -def test_autodoc_default_flags__with_values(app): +def test_autodoc_default_options_with_values(app): # with :members: - app.config.autodoc_default_flags = {'members': 'val1,val2'} + app.config.autodoc_default_options = {'members': 'val1,val2'} actual = do_autodoc(app, 'class', 'target.EnumCls') assert ' .. py:attribute:: EnumCls.val1' in actual assert ' .. py:attribute:: EnumCls.val2' in actual @@ -1523,7 +1514,7 @@ def test_autodoc_default_flags__with_values(app): # with :special-members: # Note that :members: must be *on* for :special-members: to work. - app.config.autodoc_default_flags = { + app.config.autodoc_default_options = { 'members': None, 'special-members': '__init__,__iter__', } @@ -1537,7 +1528,7 @@ def test_autodoc_default_flags__with_values(app): assert ' list of weak references to the object (if defined)' not in actual # with :exclude-members: - app.config.autodoc_default_flags = { + app.config.autodoc_default_options = { 'members': None, 'exclude-members': 'val1' } @@ -1546,7 +1537,7 @@ def test_autodoc_default_flags__with_values(app): assert ' .. py:attribute:: EnumCls.val2' in actual assert ' .. py:attribute:: EnumCls.val3' in actual assert ' .. py:attribute:: EnumCls.val4' not in actual - app.config.autodoc_default_flags = { + app.config.autodoc_default_options = { 'members': None, 'special-members': None, 'exclude-members': '__weakref__,snafucate', From f9027c6daf716a6524d55786069963365c0ada90 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 19 Aug 2018 23:14:03 +0900 Subject: [PATCH 158/174] Bump to 1.7.7 final --- CHANGES | 19 ++----------------- sphinx/__init__.py | 4 ++-- 2 files changed, 4 insertions(+), 19 deletions(-) diff --git a/CHANGES b/CHANGES index f03d1172c..24295bdea 100644 --- a/CHANGES +++ b/CHANGES @@ -1,17 +1,5 @@ -Release 1.7.7 (in development) -============================== - -Dependencies ------------- - -Incompatible changes --------------------- - -Deprecated ----------- - -Features added --------------- +Release 1.7.7 (released Aug 19, 2018) +===================================== Bugs fixed ---------- @@ -34,9 +22,6 @@ Bugs fixed * #5298: imgmath: math_number_all causes equations to have two numbers in html * #5294: sphinx-quickstart blank prompts in PowerShell -Testing --------- - Release 1.7.6 (released Jul 17, 2018) ===================================== diff --git a/sphinx/__init__.py b/sphinx/__init__.py index bb0b8fe1e..9e32f6d38 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -31,13 +31,13 @@ if 'PYTHONWARNINGS' not in os.environ: warnings.filterwarnings('ignore', "'U' mode is deprecated", DeprecationWarning, module='docutils.io') -__version__ = '1.7.7+' +__version__ = '1.7.7' __released__ = '1.7.7' # used when Sphinx builds its own docs # version info for better programmatic use # possible values for 3rd element: 'alpha', 'beta', 'rc', 'final' # 'final' has 0 as the last element -version_info = (1, 7, 7, 'beta', 0) +version_info = (1, 7, 7, 'final', 0) package_dir = path.abspath(path.dirname(__file__)) From 23716142272aa3653943527a7bebec4da621abc4 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 19 Aug 2018 23:16:34 +0900 Subject: [PATCH 159/174] Bump version --- CHANGES | 21 +++++++++++++++++++++ sphinx/__init__.py | 6 +++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 24295bdea..5f6bbaf8d 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,24 @@ +Release 1.7.8 (in development) +============================== + +Dependencies +------------ + +Incompatible changes +-------------------- + +Deprecated +---------- + +Features added +-------------- + +Bugs fixed +---------- + +Testing +-------- + Release 1.7.7 (released Aug 19, 2018) ===================================== diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 9e32f6d38..7d63364ed 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -31,13 +31,13 @@ if 'PYTHONWARNINGS' not in os.environ: warnings.filterwarnings('ignore', "'U' mode is deprecated", DeprecationWarning, module='docutils.io') -__version__ = '1.7.7' -__released__ = '1.7.7' # used when Sphinx builds its own docs +__version__ = '1.7.8+' +__released__ = '1.7.8' # used when Sphinx builds its own docs # version info for better programmatic use # possible values for 3rd element: 'alpha', 'beta', 'rc', 'final' # 'final' has 0 as the last element -version_info = (1, 7, 7, 'final', 0) +version_info = (1, 7, 8, 'beta', 0) package_dir = path.abspath(path.dirname(__file__)) From a4eec9f9fd4a083cbb9eafd7495deb0f4ee45e6f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 20 Aug 2018 00:10:11 +0900 Subject: [PATCH 160/174] Remove unused testcases --- .../test-build-multiple-latex-docs/conf.py | 10 -------- .../test-build-multiple-latex-docs/file1.rst | 4 ---- .../test-build-multiple-latex-docs/file2.rst | 4 ---- tests/test_build_latex.py | 24 ------------------- 4 files changed, 42 deletions(-) delete mode 100644 tests/roots/test-build-multiple-latex-docs/conf.py delete mode 100644 tests/roots/test-build-multiple-latex-docs/file1.rst delete mode 100644 tests/roots/test-build-multiple-latex-docs/file2.rst diff --git a/tests/roots/test-build-multiple-latex-docs/conf.py b/tests/roots/test-build-multiple-latex-docs/conf.py deleted file mode 100644 index 002f791ee..000000000 --- a/tests/roots/test-build-multiple-latex-docs/conf.py +++ /dev/null @@ -1,10 +0,0 @@ -# -*- coding: utf-8 -*- - -master_doc = 'file2' - -latex_documents = [ - ('file1', 'file1.tex', 'Multiple files building test: file1', 'Sphinx', - 'article'), - ('file2', 'file2.tex', 'Multiple files building test: file2', 'Sphinx', - 'report'), -] diff --git a/tests/roots/test-build-multiple-latex-docs/file1.rst b/tests/roots/test-build-multiple-latex-docs/file1.rst deleted file mode 100644 index 0613d1ec6..000000000 --- a/tests/roots/test-build-multiple-latex-docs/file1.rst +++ /dev/null @@ -1,4 +0,0 @@ -Testing multiple latex documents build -====================================== - -This is the first document. diff --git a/tests/roots/test-build-multiple-latex-docs/file2.rst b/tests/roots/test-build-multiple-latex-docs/file2.rst deleted file mode 100644 index a7b15a2e8..000000000 --- a/tests/roots/test-build-multiple-latex-docs/file2.rst +++ /dev/null @@ -1,4 +0,0 @@ -Testing multiple latex documents build -====================================== - -This is the second document. diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 06a6ce9a5..56c1329f7 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -122,14 +122,6 @@ def test_build_latex_doc(app, status, warning, engine, docclass): compile_latex_document(app) -@pytest.mark.sphinx('latex', testroot='build-multiple-latex-docs') -def test_build_multiple_latex_docs(app, status, warning): - app.builder.build_all() - - assert (app.outdir / 'file1.tex').isfile() - assert (app.outdir / 'file2.tex').isfile() - - @pytest.mark.sphinx('latex') def test_writer(app, status, warning): app.builder.build_all() @@ -178,27 +170,11 @@ def test_latex_basic(app, status, warning): print(result) print(status.getvalue()) print(warning.getvalue()) - assert r'\begin{document}' in result - assert r'\maketitle' in result - assert r'\sphinxtableofcontents' in result assert r'\title{The basic Sphinx documentation for testing}' in result assert r'\release{}' in result assert r'\renewcommand{\releasename}{}' in result -@pytest.mark.sphinx('latex', testroot='basic', confoverrides={'language':'de'}) -def test_latex_shorthandoff(app, status, warning): - app.builder.build_all() - result = (app.outdir / 'test.tex').text(encoding='utf8') - print(result) - print(status.getvalue()) - print(warning.getvalue()) - assert ('\\ifdefined\\shorthandoff\n' - ' \\ifnum\\catcode`\\=\\string=\\active\\shorthandoff{=}\\fi\n' - ' \\ifnum\\catcode`\\"=\\active\\shorthandoff{"}\\fi\n' - '\\fi\n' in result) - - @pytest.mark.sphinx('latex', testroot='latex-title') def test_latex_title_after_admonitions(app, status, warning): app.builder.build_all() From e4037f85cbf11a5205b6fad1a227f83a74af0cc5 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 20 Aug 2018 00:14:41 +0900 Subject: [PATCH 161/174] Update CHANGES for PR #4000 --- CHANGES | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGES b/CHANGES index ec9d36b27..a12755ebe 100644 --- a/CHANGES +++ b/CHANGES @@ -53,6 +53,13 @@ Incompatible changes before new build. * #5163: html: hlist items are now aligned to top * ``highlightlang`` directive is processed on resolving phase +* #4000: latex: LaTeX template has been chaned. Following elements are moved + into the template: + + - ``\begin{document}`` + - ``shorthandoff`` variable + - ``maketitle`` variable + - ``tableofcontents`` variable Deprecated ---------- From b7345ea3a4a8f909a202eab1214a96b015699206 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 20 Aug 2018 00:19:57 +0900 Subject: [PATCH 162/174] Update CHANGES for PR #5297 --- CHANGES | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index a12755ebe..8cef65071 100644 --- a/CHANGES +++ b/CHANGES @@ -170,7 +170,8 @@ Features added * Add ``Config.read()`` classmethod to create a new config object from configuration file * #4866: Wrap graphviz diagrams in ``
`` tag -* Add :event:`viewcode-find-source` event to viewcode extension. +* viewcode: Add :event:`viewcode-find-source` and + :event:`viewcode-follow-imported` to load source code without loading * #4785: napoleon: Add strings to translation file for localisation * #4927: Display a warning when invalid values are passed to linenothreshold option of highlight directive From 00e40cc32dc763877f683ac83d06f6ed96b5641b Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 21 Aug 2018 01:17:15 +0900 Subject: [PATCH 163/174] Bump to 1.8.0 beta1 --- CHANGES | 4 +- sphinx/__init__.py | 6 +- sphinx/locale/sphinx.pot | 2786 +++++++++++++++++++++++++++++++++----- 3 files changed, 2465 insertions(+), 331 deletions(-) diff --git a/CHANGES b/CHANGES index b1b767863..529879c74 100644 --- a/CHANGES +++ b/CHANGES @@ -1,5 +1,5 @@ -Release 1.8.0 (in development) -============================== +Release 1.8.0 beta1 (in development) +==================================== Dependencies ------------ diff --git a/sphinx/__init__.py b/sphinx/__init__.py index f4cc9048d..ab1087194 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -37,8 +37,8 @@ if 'PYTHONWARNINGS' not in os.environ: warnings.filterwarnings('ignore', "'U' mode is deprecated", DeprecationWarning, module='docutils.io') -__version__ = '1.8.0+' -__released__ = '1.8.0' # used when Sphinx builds its own docs +__version__ = '1.8.0b1' +__released__ = '1.8.0b1' # used when Sphinx builds its own docs #: Version info for better programmatic use. #: @@ -48,7 +48,7 @@ __released__ = '1.8.0' # used when Sphinx builds its own docs #: #: .. versionadded:: 1.2 #: Before version 1.2, check the string ``sphinx.__version__``. -version_info = (1, 8, 0, 'beta', 0) +version_info = (1, 8, 0, 'beta', 1) package_dir = path.abspath(path.dirname(__file__)) diff --git a/sphinx/locale/sphinx.pot b/sphinx/locale/sphinx.pot index 74417f719..6e58ba551 100644 --- a/sphinx/locale/sphinx.pot +++ b/sphinx/locale/sphinx.pot @@ -6,107 +6,133 @@ #, fuzzy msgid "" msgstr "" -"Project-Id-Version: Sphinx 1.7.0\n" +"Project-Id-Version: Sphinx 1.8.0\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2018-02-07 09:08+0900\n" +"POT-Creation-Date: 2018-08-21 01:14+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.5.3\n" +"Generated-By: Babel 2.6.0\n" -#: sphinx/application.py:176 +#: sphinx/application.py:152 +#, python-format +msgid "config directory doesn't contain a conf.py file (%s)" +msgstr "" + +#: sphinx/application.py:156 +#, python-format +msgid "Cannot find source directory (%s)" +msgstr "" + +#: sphinx/application.py:160 +msgid "Source directory and destination directory cannot be identical" +msgstr "" + +#: sphinx/application.py:191 +#, python-format +msgid "Running Sphinx v%s" +msgstr "" + +#: sphinx/application.py:214 #, python-format msgid "" "This project needs at least Sphinx v%s and therefore cannot be built with" " this version." msgstr "" -#: sphinx/application.py:207 +#: sphinx/application.py:234 +msgid "making output directory..." +msgstr "" + +#: sphinx/application.py:244 msgid "" "'setup' as currently defined in conf.py isn't a Python callable. Please " "modify its definition to make it a callable function. This is needed for " "conf.py to behave as a Sphinx extension." msgstr "" -#: sphinx/application.py:221 +#: sphinx/application.py:256 #, python-format msgid "primary_domain %r not found, ignored." msgstr "" -#: sphinx/application.py:258 sphinx/application.py:286 +#: sphinx/application.py:271 +#, python-format +msgid "loading translations [%s]... " +msgstr "" + +#: sphinx/application.py:287 sphinx/application.py:304 +#: sphinx/builders/__init__.py:380 sphinx/builders/__init__.py:387 +#: sphinx/builders/__init__.py:588 sphinx/builders/applehelp.py:134 +#: sphinx/builders/applehelp.py:178 sphinx/builders/applehelp.py:188 +#: sphinx/builders/applehelp.py:201 sphinx/builders/applehelp.py:241 +#: sphinx/builders/applehelp.py:274 sphinx/builders/html.py:956 +#: sphinx/builders/html.py:1220 sphinx/builders/html.py:1238 +#: sphinx/builders/html.py:1412 sphinx/builders/html.py:1422 +#: sphinx/builders/latex/__init__.py:339 sphinx/builders/texinfo.py:188 msgid "done" msgstr "" -#: sphinx/application.py:279 +#: sphinx/application.py:289 +msgid "not available for built-in messages" +msgstr "" + +#: sphinx/application.py:300 msgid "loading pickled environment... " msgstr "" -#: sphinx/application.py:289 -msgid "not yet created" -msgstr "" - -#: sphinx/application.py:291 +#: sphinx/application.py:306 #, python-format msgid "failed: %s" msgstr "" -#: sphinx/application.py:301 +#: sphinx/application.py:316 msgid "No builder selected, using default: html" msgstr "" -#: sphinx/application.py:333 +#: sphinx/application.py:347 msgid "succeeded" msgstr "" -#: sphinx/application.py:333 +#: sphinx/application.py:347 msgid "finished with problems" msgstr "" -#: sphinx/application.py:335 +#: sphinx/application.py:349 #, python-format msgid "build %s, %s warning." msgstr "" -#: sphinx/application.py:339 +#: sphinx/application.py:353 #, python-format msgid "build %s." msgstr "" -#: sphinx/application.py:460 -#, python-format -msgid "Config value %r already present" -msgstr "" - -#: sphinx/application.py:479 +#: sphinx/application.py:626 #, python-format msgid "" "while setting up extension %s: node class %r is already registered, its " "visitors will be overridden" msgstr "" -#: sphinx/application.py:488 -#, python-format -msgid "Value for key %r must be a (visit, depart) function tuple" -msgstr "" - -#: sphinx/application.py:528 +#: sphinx/application.py:724 #, python-format msgid "" "while setting up extension %s: directive %r is already registered, it " "will be overridden" msgstr "" -#: sphinx/application.py:539 sphinx/application.py:551 +#: sphinx/application.py:749 sphinx/application.py:770 #, python-format msgid "" "while setting up extension %s: role %r is already registered, it will be " "overridden" msgstr "" -#: sphinx/application.py:690 +#: sphinx/application.py:1268 #, python-format msgid "" "the %s extension does not declare if it is safe for parallel reading, " @@ -114,7 +140,7 @@ msgid "" "explicit" msgstr "" -#: sphinx/application.py:696 +#: sphinx/application.py:1274 #, python-format msgid "" "the %s extension does not declare if it is safe for parallel writing, " @@ -122,169 +148,291 @@ msgid "" "explicit" msgstr "" -#: sphinx/config.py:133 +#: sphinx/application.py:1285 #, python-format -msgid "Section %s" +msgid "doing serial %s" msgstr "" -#: sphinx/config.py:134 -#, python-format -msgid "Fig. %s" -msgstr "" - -#: sphinx/config.py:135 -#, python-format -msgid "Table %s" -msgstr "" - -#: sphinx/config.py:136 -#, python-format -msgid "Listing %s" -msgstr "" - -#: sphinx/config.py:249 +#: sphinx/config.py:212 #, python-format msgid "" "cannot override dictionary config setting %r, ignoring (use %r to set " "individual elements)" msgstr "" -#: sphinx/config.py:258 +#: sphinx/config.py:221 #, python-format msgid "invalid number %r for config value %r, ignoring" msgstr "" -#: sphinx/config.py:263 +#: sphinx/config.py:226 #, python-format msgid "cannot override config setting %r with unsupported type, ignoring" msgstr "" -#: sphinx/config.py:293 +#: sphinx/config.py:256 #, python-format msgid "unknown config value %r in override, ignoring" msgstr "" -#: sphinx/config.py:313 +#: sphinx/config.py:274 #, python-format msgid "No such config value: %s" msgstr "" -#: sphinx/events.py:57 +#: sphinx/config.py:304 +#, python-format +msgid "Config value %r already present" +msgstr "" + +#: sphinx/config.py:355 +#, python-format +msgid "There is a syntax error in your configuration file: %s" +msgstr "" + +#: sphinx/config.py:357 +msgid "" +"\n" +"Did you change the syntax from 2.x to 3.x?" +msgstr "" + +#: sphinx/config.py:360 +msgid "" +"The configuration file (or one of the modules it imports) called " +"sys.exit()" +msgstr "" + +#: sphinx/config.py:364 +#, python-format +msgid "" +"There is a programmable error in your configuration file:\n" +"\n" +"%s" +msgstr "" + +#: sphinx/config.py:391 +#, python-format +msgid "" +"The config value `source_suffix' expected to a string, list of strings or" +" dictionary. But `%r' is given." +msgstr "" + +#: sphinx/config.py:399 +#, python-format +msgid "Section %s" +msgstr "" + +#: sphinx/config.py:400 +#, python-format +msgid "Fig. %s" +msgstr "" + +#: sphinx/config.py:401 +#, python-format +msgid "Table %s" +msgstr "" + +#: sphinx/config.py:402 +#, python-format +msgid "Listing %s" +msgstr "" + +#: sphinx/config.py:441 +msgid "" +"The config value `{name}` has to be a one of {candidates}, but " +"`{current}` is given." +msgstr "" + +#: sphinx/config.py:459 +msgid "" +"The config value `{name}' has type `{current.__name__}', expected to " +"{permitted}." +msgstr "" + +#: sphinx/config.py:465 +msgid "" +"The config value `{name}' has type `{current.__name__}', defaults to " +"`{default.__name__}'." +msgstr "" + +#: sphinx/config.py:481 +#, python-format +msgid "" +"the config value %r is set to a string with non-ASCII characters; this " +"can lead to Unicode errors occurring. Please use Unicode strings, e.g. " +"%r." +msgstr "" + +#: sphinx/events.py:58 #, python-format msgid "Event %r already present" msgstr "" -#: sphinx/events.py:63 +#: sphinx/events.py:64 #, python-format msgid "Unknown event name: %s" msgstr "" -#: sphinx/extension.py:53 +#: sphinx/extension.py:55 #, python-format msgid "" -"The %s extension is required by needs_extensions settings,but it is not " +"The %s extension is required by needs_extensions settings, but it is not " "loaded." msgstr "" -#: sphinx/extension.py:58 +#: sphinx/extension.py:60 #, python-format msgid "" "This project needs the extension %s at least in version %s and therefore " "cannot be built with the loaded version (%s)." msgstr "" -#: sphinx/registry.py:73 +#: sphinx/highlighting.py:144 #, python-format -msgid "Builder class %s has no \"name\" attribute" +msgid "Pygments lexer name %r is not known" msgstr "" -#: sphinx/registry.py:75 +#: sphinx/highlighting.py:165 #, python-format -msgid "Builder %r already exists (in module %s)" +msgid "Could not lex literal_block as \"%s\". Highlighting skipped." msgstr "" -#: sphinx/registry.py:89 +#: sphinx/io.py:209 #, python-format -msgid "Builder name %s not registered or available through entry point" -msgstr "" - -#: sphinx/registry.py:97 -#, python-format -msgid "Builder name %s not registered" -msgstr "" - -#: sphinx/registry.py:105 -#, python-format -msgid "domain %s already registered" -msgstr "" - -#: sphinx/registry.py:130 sphinx/registry.py:142 sphinx/registry.py:150 -#: sphinx/registry.py:158 -#, python-format -msgid "domain %s not yet registered" +msgid "undecodable source characters, replacing with \"?\": %r" msgstr "" #: sphinx/registry.py:132 #, python-format -msgid "new domain not a subclass of registered %s domain" +msgid "Builder class %s has no \"name\" attribute" msgstr "" -#: sphinx/registry.py:204 +#: sphinx/registry.py:134 +#, python-format +msgid "Builder %r already exists (in module %s)" +msgstr "" + +#: sphinx/registry.py:148 +#, python-format +msgid "Builder name %s not registered or available through entry point" +msgstr "" + +#: sphinx/registry.py:156 +#, python-format +msgid "Builder name %s not registered" +msgstr "" + +#: sphinx/registry.py:164 +#, python-format +msgid "domain %s already registered" +msgstr "" + +#: sphinx/registry.py:198 sphinx/registry.py:213 sphinx/registry.py:224 +#, python-format +msgid "domain %s not yet registered" +msgstr "" + +#: sphinx/registry.py:202 +#, python-format +msgid "The %r directive is already registered to %d domain" +msgstr "" + +#: sphinx/registry.py:216 +#, python-format +msgid "The %r role is already registered to %d domain" +msgstr "" + +#: sphinx/registry.py:227 +#, python-format +msgid "The %r index is already registered to %d domain" +msgstr "" + +#: sphinx/registry.py:251 +#, python-format +msgid "The %r object_type is already registered" +msgstr "" + +#: sphinx/registry.py:271 +#, python-format +msgid "The %r crossref_type is already registered" +msgstr "" + +#: sphinx/registry.py:279 +#, python-format +msgid "source_suffix %r is already registered" +msgstr "" + +#: sphinx/registry.py:309 #, python-format msgid "source_parser for %r is already registered" msgstr "" -#: sphinx/registry.py:217 +#: sphinx/registry.py:325 #, python-format msgid "Source parser for %s not registered" msgstr "" -#: sphinx/registry.py:238 +#: sphinx/registry.py:343 #, python-format msgid "source_input for %r is already registered" msgstr "" -#: sphinx/registry.py:253 +#: sphinx/registry.py:356 #, python-format msgid "source_input for %s not registered" msgstr "" -#: sphinx/registry.py:259 +#: sphinx/registry.py:362 #, python-format -msgid "Change of translator for the %s builder." +msgid "Translatoro for %r already exists" msgstr "" -#: sphinx/registry.py:304 +#: sphinx/registry.py:374 +#, python-format +msgid "kwargs for add_node() must be a (visit, depart) function tuple: %r=%r" +msgstr "" + +#: sphinx/registry.py:444 +#, python-format +msgid "enumerable_node %r already registered" +msgstr "" + +#: sphinx/registry.py:452 +#, python-format +msgid "math renderer %s is already registred" +msgstr "" + +#: sphinx/registry.py:463 #, python-format msgid "" "the extension %r was already merged with Sphinx since version %s; this " "extension is ignored." msgstr "" -#: sphinx/registry.py:315 +#: sphinx/registry.py:474 msgid "Original exception:\n" msgstr "" -#: sphinx/registry.py:316 +#: sphinx/registry.py:475 #, python-format msgid "Could not import extension %s" msgstr "" -#: sphinx/registry.py:319 +#: sphinx/registry.py:478 #, python-format msgid "" "extension %r has no setup() function; is it really a Sphinx extension " "module?" msgstr "" -#: sphinx/registry.py:328 +#: sphinx/registry.py:487 #, python-format msgid "" "The %s extension used by this project needs at least Sphinx v%s; it " "therefore cannot be built with this version." msgstr "" -#: sphinx/registry.py:338 +#: sphinx/registry.py:495 #, python-format msgid "" "extension %r returned an unsupported object from its setup() function; it" @@ -316,6 +464,11 @@ msgstr "" msgid "setting %s.%s occurs in none of the searched theme configs" msgstr "" +#: sphinx/theming.py:136 +#, python-format +msgid "unsupported theme option %r given" +msgstr "" + #: sphinx/theming.py:238 #, python-format msgid "Theme extension %r does not respond correctly." @@ -337,368 +490,1749 @@ msgstr "" msgid "no theme named %r found (missing theme.conf?)" msgstr "" -#: sphinx/builders/changes.py:85 +#: sphinx/builders/__init__.py:226 +#, python-format +msgid "a suitable image for %s builder not found: %s (%s)" +msgstr "" + +#: sphinx/builders/__init__.py:230 +#, python-format +msgid "a suitable image for %s builder not found: %s" +msgstr "" + +#: sphinx/builders/__init__.py:252 +msgid "building [mo]: " +msgstr "" + +#: sphinx/builders/__init__.py:253 sphinx/builders/__init__.py:601 +#: sphinx/builders/__init__.py:629 +msgid "writing output... " +msgstr "" + +#: sphinx/builders/__init__.py:267 +#, python-format +msgid "all of %d po files" +msgstr "" + +#: sphinx/builders/__init__.py:289 +#, python-format +msgid "targets for %d po files that are specified" +msgstr "" + +#: sphinx/builders/__init__.py:300 +#, python-format +msgid "targets for %d po files that are out of date" +msgstr "" + +#: sphinx/builders/__init__.py:308 +msgid "all source files" +msgstr "" + +#: sphinx/builders/__init__.py:322 +#, python-format +msgid "file %r given on command line is not under the source directory, ignoring" +msgstr "" + +#: sphinx/builders/__init__.py:327 +#, python-format +msgid "file %r given on command line does not exist, ignoring" +msgstr "" + +#: sphinx/builders/__init__.py:338 +#, python-format +msgid "%d source files given on command line" +msgstr "" + +#: sphinx/builders/__init__.py:349 +#, python-format +msgid "targets for %d source files that are out of date" +msgstr "" + +#: sphinx/builders/__init__.py:359 +#, python-format +msgid "building [%s]" +msgstr "" + +#: sphinx/builders/__init__.py:366 +msgid "looking for now-outdated files... " +msgstr "" + +#: sphinx/builders/__init__.py:371 +#, python-format +msgid "%d found" +msgstr "" + +#: sphinx/builders/__init__.py:373 +msgid "none found" +msgstr "" + +#: sphinx/builders/__init__.py:377 +msgid "pickling environment... " +msgstr "" + +#: sphinx/builders/__init__.py:385 +msgid "checking consistency... " +msgstr "" + +#: sphinx/builders/__init__.py:390 +msgid "no targets are out of date." +msgstr "" + +#: sphinx/builders/__init__.py:577 +#, python-format +msgid "docnames to write: %s" +msgstr "" + +#: sphinx/builders/__init__.py:586 sphinx/builders/html.py:1410 +msgid "preparing documents... " +msgstr "" + +#: sphinx/builders/__init__.py:639 +msgid "waiting for workers..." +msgstr "" + +#: sphinx/builders/_epub_base.py:415 +#, python-format +msgid "cannot read image file %r: copying it instead" +msgstr "" + +#: sphinx/builders/_epub_base.py:421 sphinx/builders/html.py:853 +#: sphinx/builders/latex/__init__.py:353 sphinx/builders/texinfo.py:260 +#, python-format +msgid "cannot copy image file %r: %s" +msgstr "" + +#: sphinx/builders/_epub_base.py:437 +#, python-format +msgid "cannot write image file %r: %s" +msgstr "" + +#: sphinx/builders/_epub_base.py:448 +msgid "PIL not found - copying image files" +msgstr "" + +#: sphinx/builders/_epub_base.py:478 sphinx/builders/_epub_base.py:485 +#: sphinx/builders/_epub_base.py:515 sphinx/builders/_epub_base.py:694 +#: sphinx/builders/_epub_base.py:719 sphinx/builders/epub3.py:211 +#, python-format +msgid "writing %s file..." +msgstr "" + +#: sphinx/builders/_epub_base.py:541 +#, python-format +msgid "unknown mimetype for %s, ignoring" +msgstr "" + +#: sphinx/builders/applehelp.py:64 +msgid "Help indexer failed" +msgstr "" + +#: sphinx/builders/applehelp.py:68 +msgid "Code signing failed" +msgstr "" + +#: sphinx/builders/applehelp.py:77 +#, python-format +msgid "" +"The help book is in %(outdir)s.\n" +"Note that won't be able to view it unless you put it in " +"~/Library/Documentation/Help or install it in your application bundle." +msgstr "" + +#: sphinx/builders/applehelp.py:104 +msgid "You must set applehelp_bundle_id before building Apple Help output" +msgstr "" + +#: sphinx/builders/applehelp.py:128 +msgid "copying localized files... " +msgstr "" + +#: sphinx/builders/applehelp.py:175 +msgid "writing Info.plist... " +msgstr "" + +#: sphinx/builders/applehelp.py:182 +msgid "copying icon... " +msgstr "" + +#: sphinx/builders/applehelp.py:190 +#, python-format +msgid "cannot copy icon file %r: %s" +msgstr "" + +#: sphinx/builders/applehelp.py:195 +msgid "building access page..." +msgstr "" + +#: sphinx/builders/applehelp.py:204 +msgid "generating help index... " +msgstr "" + +#: sphinx/builders/applehelp.py:226 sphinx/builders/applehelp.py:260 +msgid "skipping" +msgstr "" + +#: sphinx/builders/applehelp.py:228 +#, python-format +msgid "" +"you will need to index this help book with:\n" +" %s" +msgstr "" + +#: sphinx/builders/applehelp.py:243 sphinx/builders/applehelp.py:276 +#, python-format +msgid "Command not found: %s" +msgstr "" + +#: sphinx/builders/applehelp.py:247 +msgid "signing help book... " +msgstr "" + +#: sphinx/builders/applehelp.py:261 +#, python-format +msgid "" +"you will need to sign this help book with:\n" +" %s" +msgstr "" + +#: sphinx/builders/changes.py:43 +#, python-format +msgid "The overview file is in %(outdir)s." +msgstr "" + +#: sphinx/builders/changes.py:70 +#, python-format +msgid "no changes in version %s." +msgstr "" + +#: sphinx/builders/changes.py:89 msgid "Builtins" msgstr "" -#: sphinx/builders/changes.py:87 +#: sphinx/builders/changes.py:91 msgid "Module level" msgstr "" -#: sphinx/builders/html.py:443 sphinx/transforms/__init__.py:127 -#: sphinx/writers/latex.py:583 sphinx/writers/manpage.py:110 +#: sphinx/builders/changes.py:136 +msgid "copying source files..." +msgstr "" + +#: sphinx/builders/changes.py:143 +#, python-format +msgid "could not read %r for changelog creation" +msgstr "" + +#: sphinx/builders/devhelp.py:47 +#, python-format +msgid "" +"To view the help file:\n" +"$ mkdir -p $HOME/.local/share/devhelp/books\n" +"$ ln -s $PWD/%(outdir)s $HOME/.local/share/devhelp/books/%(project)s\n" +"$ devhelp" +msgstr "" + +#: sphinx/builders/devhelp.py:73 +msgid "dumping devhelp index..." +msgstr "" + +#: sphinx/builders/dummy.py:25 +msgid "The dummy builder generates no files." +msgstr "" + +#: sphinx/builders/epub3.py:70 +#, python-format +msgid "The ePub file is in %(outdir)s." +msgstr "" + +#: sphinx/builders/epub3.py:95 +msgid "" +"conf value \"epub_language\" (or \"language\") should not be empty for " +"EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:99 +msgid "conf value \"epub_uid\" should be XML NAME for EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:102 +msgid "" +"conf value \"epub_title\" (or \"html_title\") should not be empty for " +"EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:106 +msgid "conf value \"epub_author\" should not be empty for EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:109 +msgid "conf value \"epub_contributor\" should not be empty for EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:112 +msgid "conf value \"epub_description\" should not be empty for EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:115 +msgid "conf value \"epub_publisher\" should not be empty for EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:118 +msgid "" +"conf value \"epub_copyright\" (or \"copyright\")should not be empty for " +"EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:122 +msgid "conf value \"epub_identifier\" should not be empty for EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:125 +msgid "conf value \"version\" should not be empty for EPUB3" +msgstr "" + +#: sphinx/builders/epub3.py:244 sphinx/builders/html.py:1599 +#, python-format +msgid "invalid css_file: %r, ignored" +msgstr "" + +#: sphinx/builders/gettext.py:219 +#, python-format +msgid "The message catalogs are in %(outdir)s." +msgstr "" + +#: sphinx/builders/gettext.py:243 +#, python-format +msgid "building [%s]: " +msgstr "" + +#: sphinx/builders/gettext.py:244 +#, python-format +msgid "targets for %d template files" +msgstr "" + +#: sphinx/builders/gettext.py:248 +msgid "reading templates... " +msgstr "" + +#: sphinx/builders/gettext.py:272 +msgid "writing message catalogs... " +msgstr "" + +#: sphinx/builders/html.py:240 +#, python-format +msgid "build info file is broken: %r" +msgstr "" + +#: sphinx/builders/html.py:279 +#, python-format +msgid "The HTML pages are in %(outdir)s." +msgstr "" + +#: sphinx/builders/html.py:472 +#, python-format +msgid "Failed to read build info file: %r" +msgstr "" + +#: sphinx/builders/html.py:572 sphinx/transforms/__init__.py:121 +#: sphinx/writers/latex.py:537 sphinx/writers/manpage.py:110 #: sphinx/writers/texinfo.py:240 #, python-format msgid "%b %d, %Y" msgstr "" -#: sphinx/builders/html.py:461 sphinx/themes/basic/defindex.html:30 +#: sphinx/builders/html.py:584 +msgid "html_use_opensearch config value must now be a string" +msgstr "" + +#: sphinx/builders/html.py:590 sphinx/themes/basic/defindex.html:30 msgid "General Index" msgstr "" -#: sphinx/builders/html.py:461 +#: sphinx/builders/html.py:590 msgid "index" msgstr "" -#: sphinx/builders/html.py:525 +#: sphinx/builders/html.py:654 msgid "next" msgstr "" -#: sphinx/builders/html.py:534 +#: sphinx/builders/html.py:663 msgid "previous" msgstr "" -#: sphinx/builders/html.py:1424 +#: sphinx/builders/html.py:761 +msgid "generating indices..." +msgstr "" + +#: sphinx/builders/html.py:779 +msgid "writing additional pages..." +msgstr "" + +#: sphinx/builders/html.py:845 sphinx/builders/latex/__init__.py:345 +#: sphinx/builders/texinfo.py:252 +msgid "copying images... " +msgstr "" + +#: sphinx/builders/html.py:864 +msgid "copying downloadable files... " +msgstr "" + +#: sphinx/builders/html.py:872 +#, python-format +msgid "cannot copy downloadable file %r: %s" +msgstr "" + +#: sphinx/builders/html.py:879 +msgid "copying static files... " +msgstr "" + +#: sphinx/builders/html.py:914 +#, python-format +msgid "html_static_path entry %r does not exist" +msgstr "" + +#: sphinx/builders/html.py:923 sphinx/builders/latex/__init__.py:336 +#, python-format +msgid "logo file %r does not exist" +msgstr "" + +#: sphinx/builders/html.py:931 +#, python-format +msgid "favicon file %r does not exist" +msgstr "" + +#: sphinx/builders/html.py:940 +#, python-format +msgid "cannot copy static file %r" +msgstr "" + +#: sphinx/builders/html.py:946 +msgid "copying extra files... " +msgstr "" + +#: sphinx/builders/html.py:952 +#, python-format +msgid "html_extra_path entry %r does not exist" +msgstr "" + +#: sphinx/builders/html.py:958 +#, python-format +msgid "cannot copy extra file %r" +msgstr "" + +#: sphinx/builders/html.py:966 +#, python-format +msgid "Failed to write build info file: %r" +msgstr "" + +#: sphinx/builders/html.py:1013 +msgid "" +"search index couldn't be loaded, but not all documents will be built: the" +" index will be incomplete." +msgstr "" + +#: sphinx/builders/html.py:1076 +#, python-format +msgid "page %s matches two patterns in html_sidebars: %r and %r" +msgstr "" + +#: sphinx/builders/html.py:1182 +#, python-format +msgid "" +"a Unicode error occurred when rendering the page %s. Please make sure all" +" config values that contain non-ASCII content are Unicode strings." +msgstr "" + +#: sphinx/builders/html.py:1187 +#, python-format +msgid "" +"An error happened in rendering the page %s.\n" +"Reason: %r" +msgstr "" + +#: sphinx/builders/html.py:1198 sphinx/builders/texinfo.py:245 +#: sphinx/builders/text.py:88 sphinx/builders/xml.py:101 +#, python-format +msgid "error writing file %s: %s" +msgstr "" + +#: sphinx/builders/html.py:1218 +msgid "dumping object inventory... " +msgstr "" + +#: sphinx/builders/html.py:1225 +#, python-format +msgid "dumping search index in %s ... " +msgstr "" + +#: sphinx/builders/html.py:1280 +#, python-format +msgid "The HTML page is in %(outdir)s." +msgstr "" + +#: sphinx/builders/html.py:1414 +msgid "assembling single document... " +msgstr "" + +#: sphinx/builders/html.py:1419 sphinx/builders/latex/__init__.py:213 +#: sphinx/builders/manpage.py:72 sphinx/builders/texinfo.py:171 +msgid "writing... " +msgstr "" + +#: sphinx/builders/html.py:1427 +msgid "writing additional files..." +msgstr "" + +#: sphinx/builders/html.py:1551 +#, python-format +msgid "You can now process the pickle files in %(outdir)s." +msgstr "" + +#: sphinx/builders/html.py:1572 +#, python-format +msgid "You can now process the JSON files in %(outdir)s." +msgstr "" + +#: sphinx/builders/html.py:1617 +#, python-format +msgid "invalid js_file: %r, ignored" +msgstr "" + +#: sphinx/builders/html.py:1661 +msgid "Many math_renderers are registered. But no math_renderer is selected." +msgstr "" + +#: sphinx/builders/html.py:1664 +#, python-format +msgid "Unknown math_renderer %r is given." +msgstr "" + +#: sphinx/builders/html.py:1681 #, python-format msgid "%s %s documentation" msgstr "" -#: sphinx/builders/latex.py:204 sphinx/builders/texinfo.py:224 +#: sphinx/builders/htmlhelp.py:178 +#, python-format +msgid "You can now run HTML Help Workshop with the .htp file in %(outdir)s." +msgstr "" + +#: sphinx/builders/htmlhelp.py:232 +msgid "dumping stopword list..." +msgstr "" + +#: sphinx/builders/htmlhelp.py:237 sphinx/builders/qthelp.py:99 +msgid "writing project file..." +msgstr "" + +#: sphinx/builders/htmlhelp.py:260 +msgid "writing TOC file..." +msgstr "" + +#: sphinx/builders/htmlhelp.py:302 +msgid "writing index file..." +msgstr "" + +#: sphinx/builders/linkcheck.py:95 +#, python-format +msgid "Look for any errors in the above output or in %(outdir)s/output.txt" +msgstr "" + +#: sphinx/builders/linkcheck.py:159 +#, python-format +msgid "Anchor '%s' not found" +msgstr "" + +#: sphinx/builders/linkcheck.py:257 +#, python-format +msgid "broken link: %s (%s)" +msgstr "" + +#: sphinx/builders/manpage.py:43 +#, python-format +msgid "The manual pages are in %(outdir)s." +msgstr "" + +#: sphinx/builders/manpage.py:51 +msgid "no \"man_pages\" config value found; no manual pages will be written" +msgstr "" + +#: sphinx/builders/qthelp.py:59 +#, python-format +msgid "" +"You can now run \"qcollectiongenerator\" with the .qhcp project file in " +"%(outdir)s, like this:\n" +"$ qcollectiongenerator %(outdir)s/%(project)s.qhcp\n" +"To view the help file:\n" +"$ assistant -collectionFile %(outdir)s/%(project)s.qhc" +msgstr "" + +#: sphinx/builders/qthelp.py:161 +msgid "writing collection project file..." +msgstr "" + +#: sphinx/builders/texinfo.py:101 +#, python-format +msgid "The Texinfo files are in %(outdir)s." +msgstr "" + +#: sphinx/builders/texinfo.py:103 +msgid "" +"\n" +"Run 'make' in that directory to run these through makeinfo\n" +"(use 'make info' here to do that automatically)." +msgstr "" + +#: sphinx/builders/texinfo.py:136 +msgid "no \"texinfo_documents\" config value found; no documents will be written" +msgstr "" + +#: sphinx/builders/texinfo.py:144 +#, python-format +msgid "\"texinfo_documents\" config value references unknown document %s" +msgstr "" + +#: sphinx/builders/latex/__init__.py:198 sphinx/builders/texinfo.py:167 +#, python-format +msgid "processing %s..." +msgstr "" + +#: sphinx/builders/latex/__init__.py:260 sphinx/builders/texinfo.py:215 +msgid "resolving references..." +msgstr "" + +#: sphinx/builders/latex/__init__.py:270 sphinx/builders/texinfo.py:224 msgid " (in " msgstr "" -#: sphinx/directives/code.py:66 +#: sphinx/builders/texinfo.py:237 +msgid "copying Texinfo support files... " +msgstr "" + +#: sphinx/builders/texinfo.py:246 +msgid " done" +msgstr "" + +#: sphinx/builders/text.py:35 +#, python-format +msgid "The text files are in %(outdir)s." +msgstr "" + +#: sphinx/builders/xml.py:39 +#, python-format +msgid "The XML files are in %(outdir)s." +msgstr "" + +#: sphinx/builders/xml.py:114 +#, python-format +msgid "The pseudo-XML files are in %(outdir)s." +msgstr "" + +#: sphinx/builders/latex/__init__.py:117 +#, python-format +msgid "The LaTeX files are in %(outdir)s." +msgstr "" + +#: sphinx/builders/latex/__init__.py:119 +msgid "" +"\n" +"Run 'make' in that directory to run these through (pdf)latex\n" +"(use `make latexpdf' here to do that automatically)." +msgstr "" + +#: sphinx/builders/latex/__init__.py:154 +msgid "no \"latex_documents\" config value found; no documents will be written" +msgstr "" + +#: sphinx/builders/latex/__init__.py:162 +#, python-format +msgid "\"latex_documents\" config value references unknown document %s" +msgstr "" + +#: sphinx/builders/latex/__init__.py:312 +msgid "copying TeX support files..." +msgstr "" + +#: sphinx/builders/latex/__init__.py:327 +msgid "copying additional files..." +msgstr "" + +#: sphinx/builders/latex/__init__.py:364 +#, python-format +msgid "" +"Invalid latex_documents.title found (might contain non-ASCII chars. " +"Please use u\"...\" notation instead): %r" +msgstr "" + +#: sphinx/builders/latex/__init__.py:372 +#, python-format +msgid "" +"Invalid latex_documents.author found (might contain non-ASCII chars. " +"Please use u\"...\" notation instead): %r" +msgstr "" + +#: sphinx/builders/latex/__init__.py:378 +#, python-format +msgid "Unknown configure key: latex_elements[%r]. ignored." +msgstr "" + +#: sphinx/cmd/build.py:42 +msgid "Exception occurred while building, starting debugger:" +msgstr "" + +#: sphinx/cmd/build.py:52 +msgid "interrupted!" +msgstr "" + +#: sphinx/cmd/build.py:54 +msgid "reST markup error:" +msgstr "" + +#: sphinx/cmd/build.py:60 +msgid "Encoding error:" +msgstr "" + +#: sphinx/cmd/build.py:63 sphinx/cmd/build.py:78 +#, python-format +msgid "" +"The full traceback has been saved in %s, if you want to report the issue " +"to the developers." +msgstr "" + +#: sphinx/cmd/build.py:67 +msgid "Recursion error:" +msgstr "" + +#: sphinx/cmd/build.py:70 +msgid "" +"This can happen with very large or deeply nested source files. You can " +"carefully increase the default Python recursion limit of 1000 in conf.py " +"with e.g.:" +msgstr "" + +#: sphinx/cmd/build.py:73 +msgid " import sys; sys.setrecursionlimit(1500)" +msgstr "" + +#: sphinx/cmd/build.py:75 +msgid "Exception occurred:" +msgstr "" + +#: sphinx/cmd/build.py:81 +msgid "" +"Please also report this if it was a user error, so that a better error " +"message can be provided next time." +msgstr "" + +#: sphinx/cmd/build.py:84 +msgid "" +"A bug report can be filed in the tracker at . Thanks!" +msgstr "" + +#: sphinx/cmd/build.py:101 +msgid "job number should be a positive number" +msgstr "" + +#: sphinx/cmd/build.py:110 sphinx/cmd/quickstart.py:528 +#: sphinx/ext/apidoc.py:303 sphinx/ext/autosummary/generate.py:369 +msgid "For more information, visit ." +msgstr "" + +#: sphinx/cmd/build.py:111 +msgid "" +"\n" +"Generate documentation from source files.\n" +"\n" +"sphinx-build generates documentation from the files in SOURCEDIR and " +"places it\n" +"in OUTPUTDIR. It looks for 'conf.py' in SOURCEDIR for the configuration\n" +"settings. The 'sphinx-quickstart' tool may be used to generate template " +"files,\n" +"including 'conf.py'\n" +"\n" +"sphinx-build can create documentation in different formats. A format is\n" +"selected by specifying the builder name on the command line; it defaults " +"to\n" +"HTML. Builders can also perform other tasks related to documentation\n" +"processing.\n" +"\n" +"By default, everything that is outdated is built. Output only for " +"selected\n" +"files can be built by specifying individual filenames.\n" +msgstr "" + +#: sphinx/cmd/build.py:132 +msgid "path to documentation source files" +msgstr "" + +#: sphinx/cmd/build.py:134 +msgid "path to output directory" +msgstr "" + +#: sphinx/cmd/build.py:136 +msgid "a list of specific files to rebuild. Ignored if -a is specified" +msgstr "" + +#: sphinx/cmd/build.py:139 +msgid "general options" +msgstr "" + +#: sphinx/cmd/build.py:142 +msgid "builder to use (default: html)" +msgstr "" + +#: sphinx/cmd/build.py:144 +msgid "write all files (default: only write new and changed files)" +msgstr "" + +#: sphinx/cmd/build.py:147 +msgid "don't use a saved environment, always read all files" +msgstr "" + +#: sphinx/cmd/build.py:150 +msgid "" +"path for the cached environment and doctree files (default: " +"OUTPUTDIR/.doctrees)" +msgstr "" + +#: sphinx/cmd/build.py:153 +msgid "" +"build in parallel with N processes where possible (special value \"auto\"" +" will set N to cpu-count)" +msgstr "" + +#: sphinx/cmd/build.py:157 +msgid "" +"path where configuration file (conf.py) is located (default: same as " +"SOURCEDIR)" +msgstr "" + +#: sphinx/cmd/build.py:160 +msgid "use no config file at all, only -D options" +msgstr "" + +#: sphinx/cmd/build.py:163 +msgid "override a setting in configuration file" +msgstr "" + +#: sphinx/cmd/build.py:166 +msgid "pass a value into HTML templates" +msgstr "" + +#: sphinx/cmd/build.py:169 +msgid "define tag: include \"only\" blocks with TAG" +msgstr "" + +#: sphinx/cmd/build.py:171 +msgid "nit-picky mode, warn about all missing references" +msgstr "" + +#: sphinx/cmd/build.py:174 +msgid "console output options" +msgstr "" + +#: sphinx/cmd/build.py:176 +msgid "increase verbosity (can be repeated)" +msgstr "" + +#: sphinx/cmd/build.py:178 +msgid "no output on stdout, just warnings on stderr" +msgstr "" + +#: sphinx/cmd/build.py:180 +msgid "no output at all, not even warnings" +msgstr "" + +#: sphinx/cmd/build.py:183 +msgid "do emit colored output (default: auto-detect)" +msgstr "" + +#: sphinx/cmd/build.py:186 +msgid "do not emit colored output (default: auto-detect)" +msgstr "" + +#: sphinx/cmd/build.py:189 +msgid "write warnings (and errors) to given file" +msgstr "" + +#: sphinx/cmd/build.py:191 +msgid "turn warnings into errors" +msgstr "" + +#: sphinx/cmd/build.py:193 +msgid "With -W, Keep going when getting warnings" +msgstr "" + +#: sphinx/cmd/build.py:195 +msgid "show full traceback on exception" +msgstr "" + +#: sphinx/cmd/build.py:197 +msgid "run Pdb on exception" +msgstr "" + +#: sphinx/cmd/build.py:231 +#, python-format +msgid "cannot find files %r" +msgstr "" + +#: sphinx/cmd/build.py:241 +msgid "cannot combine -a option and filenames" +msgstr "" + +#: sphinx/cmd/build.py:260 +#, python-format +msgid "cannot open warning file %r: %s" +msgstr "" + +#: sphinx/cmd/build.py:270 +msgid "-D option argument must be in the form name=value" +msgstr "" + +#: sphinx/cmd/build.py:282 +msgid "-A option argument must be in the form name=value" +msgstr "" + +#: sphinx/cmd/quickstart.py:56 +msgid "automatically insert docstrings from modules" +msgstr "" + +#: sphinx/cmd/quickstart.py:57 +msgid "automatically test code snippets in doctest blocks" +msgstr "" + +#: sphinx/cmd/quickstart.py:58 +msgid "link between Sphinx documentation of different projects" +msgstr "" + +#: sphinx/cmd/quickstart.py:59 +msgid "write \"todo\" entries that can be shown or hidden on build" +msgstr "" + +#: sphinx/cmd/quickstart.py:60 +msgid "checks for documentation coverage" +msgstr "" + +#: sphinx/cmd/quickstart.py:61 +msgid "include math, rendered as PNG or SVG images" +msgstr "" + +#: sphinx/cmd/quickstart.py:62 +msgid "include math, rendered in the browser by MathJax" +msgstr "" + +#: sphinx/cmd/quickstart.py:63 +msgid "conditional inclusion of content based on config values" +msgstr "" + +#: sphinx/cmd/quickstart.py:65 +msgid "include links to the source code of documented Python objects" +msgstr "" + +#: sphinx/cmd/quickstart.py:67 +msgid "create .nojekyll file to publish the document on GitHub pages" +msgstr "" + +#: sphinx/cmd/quickstart.py:111 +msgid "Please enter a valid path name." +msgstr "" + +#: sphinx/cmd/quickstart.py:123 +msgid "Please enter some text." +msgstr "" + +#: sphinx/cmd/quickstart.py:132 +#, python-format +msgid "Please enter one of %s." +msgstr "" + +#: sphinx/cmd/quickstart.py:140 +msgid "Please enter either 'y' or 'n'." +msgstr "" + +#: sphinx/cmd/quickstart.py:147 +msgid "Please enter a file suffix, e.g. '.rst' or '.txt'." +msgstr "" + +#: sphinx/cmd/quickstart.py:170 +msgid "" +"* Note: non-ASCII characters entered and terminal encoding unknown -- " +"assuming UTF-8 or Latin-1." +msgstr "" + +#: sphinx/cmd/quickstart.py:193 +msgid "" +"* Note: non-ASCII default value provided and terminal encoding unknown --" +" assuming UTF-8 or Latin-1." +msgstr "" + +#: sphinx/cmd/quickstart.py:259 +#, python-format +msgid "Welcome to the Sphinx %s quickstart utility." +msgstr "" + +#: sphinx/cmd/quickstart.py:260 +msgid "" +"\n" +"Please enter values for the following settings (just press Enter to\n" +"accept a default value, if one is given in brackets)." +msgstr "" + +#: sphinx/cmd/quickstart.py:265 +#, python-format +msgid "" +"\n" +"Selected root path: %s" +msgstr "" + +#: sphinx/cmd/quickstart.py:268 +msgid "" +"\n" +"Enter the root path for documentation." +msgstr "" + +#: sphinx/cmd/quickstart.py:270 +msgid "Root path for the documentation" +msgstr "" + +#: sphinx/cmd/quickstart.py:275 +msgid "Error: an existing conf.py has been found in the selected root path." +msgstr "" + +#: sphinx/cmd/quickstart.py:277 +msgid "sphinx-quickstart will not overwrite existing Sphinx projects." +msgstr "" + +#: sphinx/cmd/quickstart.py:279 +msgid "Please enter a new root path (or just Enter to exit)" +msgstr "" + +#: sphinx/cmd/quickstart.py:285 +msgid "" +"\n" +"You have two options for placing the build directory for Sphinx output.\n" +"Either, you use a directory \"_build\" within the root path, or you " +"separate\n" +"\"source\" and \"build\" directories within the root path." +msgstr "" + +#: sphinx/cmd/quickstart.py:289 +msgid "Separate source and build directories (y/n)" +msgstr "" + +#: sphinx/cmd/quickstart.py:293 +msgid "" +"\n" +"Inside the root directory, two more directories will be created; " +"\"_templates\"\n" +"for custom HTML templates and \"_static\" for custom stylesheets and " +"other static\n" +"files. You can enter another prefix (such as \".\") to replace the " +"underscore." +msgstr "" + +#: sphinx/cmd/quickstart.py:297 +msgid "Name prefix for templates and static dir" +msgstr "" + +#: sphinx/cmd/quickstart.py:300 +msgid "" +"\n" +"The project name will occur in several places in the built documentation." +msgstr "" + +#: sphinx/cmd/quickstart.py:302 +msgid "Project name" +msgstr "" + +#: sphinx/cmd/quickstart.py:304 +msgid "Author name(s)" +msgstr "" + +#: sphinx/cmd/quickstart.py:307 +msgid "" +"\n" +"Sphinx has the notion of a \"version\" and a \"release\" for the\n" +"software. Each version can have multiple releases. For example, for\n" +"Python the version is something like 2.5 or 3.0, while the release is\n" +"something like 2.5.1 or 3.0a1. If you don't need this dual structure,\n" +"just set both to the same value." +msgstr "" + +#: sphinx/cmd/quickstart.py:313 +msgid "Project version" +msgstr "" + +#: sphinx/cmd/quickstart.py:315 +msgid "Project release" +msgstr "" + +#: sphinx/cmd/quickstart.py:318 +msgid "" +"\n" +"If the documents are to be written in a language other than English,\n" +"you can select a language here by its language code. Sphinx will then\n" +"translate text that it generates into that language.\n" +"\n" +"For a list of supported codes, see\n" +"http://sphinx-doc.org/config.html#confval-language." +msgstr "" + +#: sphinx/cmd/quickstart.py:325 +msgid "Project language" +msgstr "" + +#: sphinx/cmd/quickstart.py:330 +msgid "" +"\n" +"The file name suffix for source files. Commonly, this is either \".txt\"\n" +"or \".rst\". Only files with this suffix are considered documents." +msgstr "" + +#: sphinx/cmd/quickstart.py:333 +msgid "Source file suffix" +msgstr "" + +#: sphinx/cmd/quickstart.py:336 +msgid "" +"\n" +"One document is special in that it is considered the top node of the\n" +"\"contents tree\", that is, it is the root of the hierarchical structure\n" +"of the documents. Normally, this is \"index\", but if your \"index\"\n" +"document is a custom template, you can also set this to another filename." +msgstr "" + +#: sphinx/cmd/quickstart.py:341 +msgid "Name of your master document (without suffix)" +msgstr "" + +#: sphinx/cmd/quickstart.py:347 +#, python-format +msgid "" +"Error: the master file %s has already been found in the selected root " +"path." +msgstr "" + +#: sphinx/cmd/quickstart.py:349 +msgid "sphinx-quickstart will not overwrite the existing file." +msgstr "" + +#: sphinx/cmd/quickstart.py:351 +msgid "Please enter a new file name, or rename the existing file and press Enter" +msgstr "" + +#: sphinx/cmd/quickstart.py:355 +msgid "Indicate which of the following Sphinx extensions should be enabled:" +msgstr "" + +#: sphinx/cmd/quickstart.py:365 +msgid "" +"Note: imgmath and mathjax cannot be enabled at the same time. imgmath has" +" been deselected." +msgstr "" + +#: sphinx/cmd/quickstart.py:370 +msgid "" +"\n" +"A Makefile and a Windows command file can be generated for you so that " +"you\n" +"only have to run e.g. `make html' instead of invoking sphinx-build\n" +"directly." +msgstr "" + +#: sphinx/cmd/quickstart.py:374 +msgid "Create Makefile? (y/n)" +msgstr "" + +#: sphinx/cmd/quickstart.py:377 +msgid "Create Windows command file? (y/n)" +msgstr "" + +#: sphinx/cmd/quickstart.py:439 sphinx/ext/apidoc.py:79 +#, python-format +msgid "Creating file %s." +msgstr "" + +#: sphinx/cmd/quickstart.py:444 sphinx/ext/apidoc.py:77 +#, python-format +msgid "File %s already exists, skipping." +msgstr "" + +#: sphinx/cmd/quickstart.py:480 +msgid "Finished: An initial directory structure has been created." +msgstr "" + +#: sphinx/cmd/quickstart.py:481 +#, python-format +msgid "" +"\n" +"You should now populate your master file %s and create other " +"documentation\n" +"source files. " +msgstr "" + +#: sphinx/cmd/quickstart.py:483 +msgid "" +"Use the Makefile to build the docs, like so:\n" +" make builder\n" +msgstr "" + +#: sphinx/cmd/quickstart.py:486 +#, python-format +msgid "" +"Use the sphinx-build command to build the docs, like so:\n" +" sphinx-build -b builder %s %s\n" +msgstr "" + +#: sphinx/cmd/quickstart.py:489 +msgid "" +"where \"builder\" is one of the supported builders, e.g. html, latex or " +"linkcheck.\n" +msgstr "" + +#: sphinx/cmd/quickstart.py:529 +msgid "" +"\n" +"Generate required files for a Sphinx project.\n" +"\n" +"sphinx-quickstart is an interactive tool that asks some questions about " +"your\n" +"project and then generates a complete documentation directory and sample\n" +"Makefile to be used with sphinx-build.\n" +msgstr "" + +#: sphinx/cmd/quickstart.py:539 +msgid "quiet mode" +msgstr "" + +#: sphinx/cmd/quickstart.py:544 +msgid "output path" +msgstr "" + +#: sphinx/cmd/quickstart.py:546 +msgid "Structure options" +msgstr "" + +#: sphinx/cmd/quickstart.py:548 +msgid "if specified, separate source and build dirs" +msgstr "" + +#: sphinx/cmd/quickstart.py:550 +msgid "replacement for dot in _templates etc." +msgstr "" + +#: sphinx/cmd/quickstart.py:552 +msgid "Project basic options" +msgstr "" + +#: sphinx/cmd/quickstart.py:554 +msgid "project name" +msgstr "" + +#: sphinx/cmd/quickstart.py:556 +msgid "author names" +msgstr "" + +#: sphinx/cmd/quickstart.py:558 +msgid "version of project" +msgstr "" + +#: sphinx/cmd/quickstart.py:560 +msgid "release of project" +msgstr "" + +#: sphinx/cmd/quickstart.py:562 +msgid "document language" +msgstr "" + +#: sphinx/cmd/quickstart.py:564 +msgid "source file suffix" +msgstr "" + +#: sphinx/cmd/quickstart.py:566 +msgid "master document name" +msgstr "" + +#: sphinx/cmd/quickstart.py:568 +msgid "use epub" +msgstr "" + +#: sphinx/cmd/quickstart.py:570 +msgid "Extension options" +msgstr "" + +#: sphinx/cmd/quickstart.py:574 sphinx/ext/apidoc.py:380 +#, python-format +msgid "enable %s extension" +msgstr "" + +#: sphinx/cmd/quickstart.py:576 +msgid "enable arbitrary extensions" +msgstr "" + +#: sphinx/cmd/quickstart.py:578 +msgid "Makefile and Batchfile creation" +msgstr "" + +#: sphinx/cmd/quickstart.py:580 +msgid "create makefile" +msgstr "" + +#: sphinx/cmd/quickstart.py:582 +msgid "do not create makefile" +msgstr "" + +#: sphinx/cmd/quickstart.py:584 +msgid "create batchfile" +msgstr "" + +#: sphinx/cmd/quickstart.py:587 +msgid "do not create batchfile" +msgstr "" + +#: sphinx/cmd/quickstart.py:590 +msgid "use make-mode for Makefile/make.bat" +msgstr "" + +#: sphinx/cmd/quickstart.py:593 +msgid "do not use make-mode for Makefile/make.bat" +msgstr "" + +#: sphinx/cmd/quickstart.py:595 +msgid "Project templating" +msgstr "" + +#: sphinx/cmd/quickstart.py:598 +msgid "template directory for template files" +msgstr "" + +#: sphinx/cmd/quickstart.py:601 +msgid "define a template variable" +msgstr "" + +#: sphinx/cmd/quickstart.py:628 +msgid "" +"\"quiet\" is specified, but any of \"project\" or \"author\" is not " +"specified." +msgstr "" + +#: sphinx/cmd/quickstart.py:642 +msgid "Error: specified path is not a directory, or sphinx files already exist." +msgstr "" + +#: sphinx/cmd/quickstart.py:644 +msgid "" +"sphinx-quickstart only generate into a empty directory. Please specify a " +"new root path." +msgstr "" + +#: sphinx/cmd/quickstart.py:671 +#, python-format +msgid "Invalid template variable: %s" +msgstr "" + +#: sphinx/directives/code.py:75 msgid "Over dedent has detected" msgstr "" -#: sphinx/directives/code.py:86 +#: sphinx/directives/code.py:95 #, python-format msgid "Invalid caption: %s" msgstr "" -#: sphinx/directives/code.py:201 +#: sphinx/directives/code.py:138 sphinx/directives/code.py:280 +#: sphinx/directives/code.py:450 +#, python-format +msgid "line number spec is out of range(1-%d): %r" +msgstr "" + +#: sphinx/directives/code.py:210 #, python-format msgid "Cannot use both \"%s\" and \"%s\" options" msgstr "" -#: sphinx/directives/code.py:214 +#: sphinx/directives/code.py:223 #, python-format msgid "Include file %r not found or reading it failed" msgstr "" -#: sphinx/directives/code.py:216 +#: sphinx/directives/code.py:225 #, python-format msgid "" "Encoding %r used for reading included file %r seems to be wrong, try " "giving an :encoding: option" msgstr "" -#: sphinx/directives/code.py:254 +#: sphinx/directives/code.py:263 #, python-format msgid "Object named %r not found in include file %r" msgstr "" -#: sphinx/directives/code.py:280 +#: sphinx/directives/code.py:289 msgid "Cannot use \"lineno-match\" with a disjoint set of \"lines\"" msgstr "" -#: sphinx/directives/code.py:285 +#: sphinx/directives/code.py:294 #, python-format msgid "Line spec %r: no lines pulled from include file %r" msgstr "" -#: sphinx/directives/other.py:157 +#: sphinx/directives/other.py:169 msgid "Section author: " msgstr "" -#: sphinx/directives/other.py:159 +#: sphinx/directives/other.py:171 msgid "Module author: " msgstr "" -#: sphinx/directives/other.py:161 +#: sphinx/directives/other.py:173 msgid "Code author: " msgstr "" -#: sphinx/directives/other.py:163 +#: sphinx/directives/other.py:175 msgid "Author: " msgstr "" -#: sphinx/domains/__init__.py:334 +#: sphinx/domains/__init__.py:336 #, python-format msgid "%s %s" msgstr "" -#: sphinx/domains/c.py:65 sphinx/domains/cpp.py:5440 -#: sphinx/domains/python.py:176 +#: sphinx/domains/c.py:65 sphinx/domains/cpp.py:6070 +#: sphinx/domains/python.py:212 sphinx/ext/napoleon/docstring.py:695 msgid "Parameters" msgstr "" -#: sphinx/domains/c.py:68 sphinx/domains/cpp.py:5449 -#: sphinx/domains/javascript.py:210 sphinx/domains/python.py:188 +#: sphinx/domains/c.py:68 sphinx/domains/cpp.py:6079 +#: sphinx/domains/javascript.py:211 sphinx/domains/python.py:224 msgid "Returns" msgstr "" -#: sphinx/domains/c.py:70 sphinx/domains/javascript.py:212 -#: sphinx/domains/python.py:190 +#: sphinx/domains/c.py:70 sphinx/domains/javascript.py:213 +#: sphinx/domains/python.py:226 msgid "Return type" msgstr "" -#: sphinx/domains/c.py:188 +#: sphinx/domains/c.py:189 #, python-format msgid "%s (C function)" msgstr "" -#: sphinx/domains/c.py:190 +#: sphinx/domains/c.py:191 #, python-format msgid "%s (C member)" msgstr "" -#: sphinx/domains/c.py:192 +#: sphinx/domains/c.py:193 #, python-format msgid "%s (C macro)" msgstr "" -#: sphinx/domains/c.py:194 +#: sphinx/domains/c.py:195 #, python-format msgid "%s (C type)" msgstr "" -#: sphinx/domains/c.py:196 +#: sphinx/domains/c.py:197 #, python-format msgid "%s (C variable)" msgstr "" -#: sphinx/domains/c.py:257 sphinx/domains/cpp.py:5863 -#: sphinx/domains/javascript.py:299 sphinx/domains/python.py:705 +#: sphinx/domains/c.py:258 sphinx/domains/cpp.py:6547 +#: sphinx/domains/javascript.py:299 sphinx/domains/python.py:740 msgid "function" msgstr "" -#: sphinx/domains/c.py:258 sphinx/domains/cpp.py:5864 +#: sphinx/domains/c.py:259 sphinx/domains/cpp.py:6548 msgid "member" msgstr "" -#: sphinx/domains/c.py:259 +#: sphinx/domains/c.py:260 msgid "macro" msgstr "" -#: sphinx/domains/c.py:260 sphinx/domains/cpp.py:5865 +#: sphinx/domains/c.py:261 sphinx/domains/cpp.py:6549 msgid "type" msgstr "" -#: sphinx/domains/c.py:261 +#: sphinx/domains/c.py:262 msgid "variable" msgstr "" -#: sphinx/domains/cpp.py:5443 +#: sphinx/domains/changeset.py:34 +#, python-format +msgid "New in version %s" +msgstr "" + +#: sphinx/domains/changeset.py:35 +#, python-format +msgid "Changed in version %s" +msgstr "" + +#: sphinx/domains/changeset.py:36 +#, python-format +msgid "Deprecated since version %s" +msgstr "" + +#: sphinx/domains/cpp.py:4037 +#, python-format +msgid "" +"Duplicate declaration, also defined in '%s'.\n" +"Declaration is '%s'." +msgstr "" + +#: sphinx/domains/cpp.py:6073 msgid "Template Parameters" msgstr "" -#: sphinx/domains/cpp.py:5446 sphinx/domains/javascript.py:207 +#: sphinx/domains/cpp.py:6076 sphinx/domains/javascript.py:208 msgid "Throws" msgstr "" -#: sphinx/domains/cpp.py:5628 +#: sphinx/domains/cpp.py:6283 #, python-format msgid "%s (C++ type)" msgstr "" -#: sphinx/domains/cpp.py:5638 +#: sphinx/domains/cpp.py:6293 #, python-format msgid "%s (C++ concept)" msgstr "" -#: sphinx/domains/cpp.py:5648 +#: sphinx/domains/cpp.py:6303 #, python-format msgid "%s (C++ member)" msgstr "" -#: sphinx/domains/cpp.py:5658 +#: sphinx/domains/cpp.py:6313 #, python-format msgid "%s (C++ function)" msgstr "" -#: sphinx/domains/cpp.py:5668 +#: sphinx/domains/cpp.py:6323 #, python-format msgid "%s (C++ class)" msgstr "" -#: sphinx/domains/cpp.py:5678 +#: sphinx/domains/cpp.py:6333 +#, python-format +msgid "%s (C++ union)" +msgstr "" + +#: sphinx/domains/cpp.py:6343 #, python-format msgid "%s (C++ enum)" msgstr "" -#: sphinx/domains/cpp.py:5698 +#: sphinx/domains/cpp.py:6363 #, python-format msgid "%s (C++ enumerator)" msgstr "" -#: sphinx/domains/cpp.py:5862 sphinx/domains/javascript.py:301 -#: sphinx/domains/python.py:707 +#: sphinx/domains/cpp.py:6545 sphinx/domains/javascript.py:301 +#: sphinx/domains/python.py:742 msgid "class" msgstr "" -#: sphinx/domains/cpp.py:5866 +#: sphinx/domains/cpp.py:6546 +msgid "union" +msgstr "" + +#: sphinx/domains/cpp.py:6550 msgid "concept" msgstr "" -#: sphinx/domains/cpp.py:5867 +#: sphinx/domains/cpp.py:6551 msgid "enum" msgstr "" -#: sphinx/domains/cpp.py:5868 +#: sphinx/domains/cpp.py:6552 msgid "enumerator" msgstr "" -#: sphinx/domains/javascript.py:131 sphinx/domains/python.py:395 +#: sphinx/domains/cpp.py:6617 +#, python-format +msgid "" +"Duplicate declaration, also defined in '%s'.\n" +"Name of declaration is '%s'." +msgstr "" + +#: sphinx/domains/javascript.py:132 sphinx/domains/python.py:431 #, python-format msgid "%s() (built-in function)" msgstr "" -#: sphinx/domains/javascript.py:132 sphinx/domains/python.py:460 +#: sphinx/domains/javascript.py:133 sphinx/domains/python.py:496 #, python-format msgid "%s() (%s method)" msgstr "" -#: sphinx/domains/javascript.py:134 +#: sphinx/domains/javascript.py:135 #, python-format msgid "%s() (class)" msgstr "" -#: sphinx/domains/javascript.py:136 +#: sphinx/domains/javascript.py:137 #, python-format msgid "%s (global variable or constant)" msgstr "" -#: sphinx/domains/javascript.py:138 sphinx/domains/python.py:498 +#: sphinx/domains/javascript.py:139 sphinx/domains/python.py:534 #, python-format msgid "%s (%s attribute)" msgstr "" -#: sphinx/domains/javascript.py:204 +#: sphinx/domains/javascript.py:205 msgid "Arguments" msgstr "" -#: sphinx/domains/javascript.py:266 sphinx/domains/python.py:575 +#: sphinx/domains/javascript.py:266 sphinx/domains/python.py:611 #, python-format msgid "%s (module)" msgstr "" -#: sphinx/domains/javascript.py:300 sphinx/domains/python.py:709 +#: sphinx/domains/javascript.py:300 sphinx/domains/python.py:744 msgid "method" msgstr "" -#: sphinx/domains/javascript.py:302 sphinx/domains/python.py:706 +#: sphinx/domains/javascript.py:302 sphinx/domains/python.py:741 msgid "data" msgstr "" -#: sphinx/domains/javascript.py:303 sphinx/domains/python.py:712 +#: sphinx/domains/javascript.py:303 sphinx/domains/python.py:747 msgid "attribute" msgstr "" -#: sphinx/domains/javascript.py:304 sphinx/domains/python.py:713 -#: sphinx/locale/__init__.py:218 +#: sphinx/domains/javascript.py:304 sphinx/domains/python.py:50 +#: sphinx/domains/python.py:748 msgid "module" msgstr "" -#: sphinx/domains/python.py:181 +#: sphinx/domains/math.py:88 sphinx/writers/latex.py:2529 +#, python-format +msgid "Invalid math_eqref_format: %r" +msgstr "" + +#: sphinx/domains/math.py:113 +#, python-format +msgid "duplicate label of equation %s, other instance in %s" +msgstr "" + +#: sphinx/domains/python.py:51 +msgid "keyword" +msgstr "" + +#: sphinx/domains/python.py:52 +msgid "operator" +msgstr "" + +#: sphinx/domains/python.py:53 +msgid "object" +msgstr "" + +#: sphinx/domains/python.py:54 sphinx/domains/python.py:743 +msgid "exception" +msgstr "" + +#: sphinx/domains/python.py:55 +msgid "statement" +msgstr "" + +#: sphinx/domains/python.py:56 +msgid "built-in function" +msgstr "" + +#: sphinx/domains/python.py:217 msgid "Variables" msgstr "" -#: sphinx/domains/python.py:185 +#: sphinx/domains/python.py:221 msgid "Raises" msgstr "" -#: sphinx/domains/python.py:396 sphinx/domains/python.py:454 -#: sphinx/domains/python.py:466 sphinx/domains/python.py:479 +#: sphinx/domains/python.py:432 sphinx/domains/python.py:490 +#: sphinx/domains/python.py:502 sphinx/domains/python.py:515 #, python-format msgid "%s() (in module %s)" msgstr "" -#: sphinx/domains/python.py:399 +#: sphinx/domains/python.py:435 #, python-format msgid "%s (built-in variable)" msgstr "" -#: sphinx/domains/python.py:400 sphinx/domains/python.py:492 +#: sphinx/domains/python.py:436 sphinx/domains/python.py:528 #, python-format msgid "%s (in module %s)" msgstr "" -#: sphinx/domains/python.py:420 +#: sphinx/domains/python.py:456 #, python-format msgid "%s (built-in class)" msgstr "" -#: sphinx/domains/python.py:421 +#: sphinx/domains/python.py:457 #, python-format msgid "%s (class in %s)" msgstr "" -#: sphinx/domains/python.py:458 +#: sphinx/domains/python.py:494 #, python-format msgid "%s() (%s.%s method)" msgstr "" -#: sphinx/domains/python.py:470 +#: sphinx/domains/python.py:506 #, python-format msgid "%s() (%s.%s static method)" msgstr "" -#: sphinx/domains/python.py:473 +#: sphinx/domains/python.py:509 #, python-format msgid "%s() (%s static method)" msgstr "" -#: sphinx/domains/python.py:483 +#: sphinx/domains/python.py:519 #, python-format msgid "%s() (%s.%s class method)" msgstr "" -#: sphinx/domains/python.py:486 +#: sphinx/domains/python.py:522 #, python-format msgid "%s() (%s class method)" msgstr "" -#: sphinx/domains/python.py:496 +#: sphinx/domains/python.py:532 #, python-format msgid "%s (%s.%s attribute)" msgstr "" -#: sphinx/domains/python.py:634 +#: sphinx/domains/python.py:669 msgid "Python Module Index" msgstr "" -#: sphinx/domains/python.py:635 +#: sphinx/domains/python.py:670 msgid "modules" msgstr "" -#: sphinx/domains/python.py:683 +#: sphinx/domains/python.py:718 msgid "Deprecated" msgstr "" -#: sphinx/domains/python.py:708 sphinx/locale/__init__.py:222 -msgid "exception" -msgstr "" - -#: sphinx/domains/python.py:710 +#: sphinx/domains/python.py:745 msgid "class method" msgstr "" -#: sphinx/domains/python.py:711 +#: sphinx/domains/python.py:746 msgid "static method" msgstr "" -#: sphinx/domains/python.py:883 +#: sphinx/domains/python.py:878 +#, python-format +msgid "more than one target found for cross-reference %r: %s" +msgstr "" + +#: sphinx/domains/python.py:918 msgid " (deprecated)" msgstr "" @@ -720,58 +2254,152 @@ msgstr "" msgid "role" msgstr "" -#: sphinx/domains/std.py:83 sphinx/domains/std.py:100 +#: sphinx/domains/std.py:88 sphinx/domains/std.py:105 #, python-format msgid "environment variable; %s" msgstr "" -#: sphinx/domains/std.py:199 +#: sphinx/domains/std.py:164 +#, python-format +msgid "" +"Malformed option description %r, should look like \"opt\", \"-opt args\"," +" \"--opt args\", \"/opt args\" or \"+opt args\"" +msgstr "" + +#: sphinx/domains/std.py:203 #, python-format msgid "%scommand line option; %s" msgstr "" -#: sphinx/domains/std.py:454 +#: sphinx/domains/std.py:455 msgid "glossary term" msgstr "" -#: sphinx/domains/std.py:455 +#: sphinx/domains/std.py:456 msgid "grammar token" msgstr "" -#: sphinx/domains/std.py:456 +#: sphinx/domains/std.py:457 msgid "reference label" msgstr "" -#: sphinx/domains/std.py:458 +#: sphinx/domains/std.py:459 msgid "environment variable" msgstr "" -#: sphinx/domains/std.py:459 +#: sphinx/domains/std.py:460 msgid "program option" msgstr "" -#: sphinx/domains/std.py:460 +#: sphinx/domains/std.py:461 msgid "document" msgstr "" -#: sphinx/domains/std.py:497 sphinx/themes/basic/genindex-single.html:30 +#: sphinx/domains/std.py:498 sphinx/themes/basic/genindex-single.html:30 #: sphinx/themes/basic/genindex-single.html:55 #: sphinx/themes/basic/genindex-split.html:11 #: sphinx/themes/basic/genindex-split.html:14 #: sphinx/themes/basic/genindex.html:30 sphinx/themes/basic/genindex.html:33 -#: sphinx/themes/basic/genindex.html:66 sphinx/themes/basic/layout.html:147 -#: sphinx/writers/latex.py:550 sphinx/writers/texinfo.py:516 +#: sphinx/themes/basic/genindex.html:66 sphinx/themes/basic/layout.html:150 +#: sphinx/writers/latex.py:503 sphinx/writers/texinfo.py:516 msgid "Index" msgstr "" -#: sphinx/domains/std.py:498 +#: sphinx/domains/std.py:499 msgid "Module Index" msgstr "" -#: sphinx/domains/std.py:499 sphinx/themes/basic/defindex.html:25 +#: sphinx/domains/std.py:500 sphinx/themes/basic/defindex.html:25 msgid "Search Page" msgstr "" +#: sphinx/domains/std.py:595 +#, python-format +msgid "duplicate citation %s, other instance in %s" +msgstr "" + +#: sphinx/domains/std.py:627 sphinx/ext/autosectionlabel.py:47 +#, python-format +msgid "duplicate label %s, other instance in %s" +msgstr "" + +#: sphinx/domains/std.py:652 +#, python-format +msgid "Citation [%s] is not referenced." +msgstr "" + +#: sphinx/domains/std.py:735 +msgid "numfig is disabled. :numref: is ignored." +msgstr "" + +#: sphinx/domains/std.py:743 +#, python-format +msgid "no number is assigned for %s: %s" +msgstr "" + +#: sphinx/domains/std.py:754 +#, python-format +msgid "the link has no caption: %s" +msgstr "" + +#: sphinx/domains/std.py:768 +#, python-format +msgid "invalid numfig_format: %s (%r)" +msgstr "" + +#: sphinx/domains/std.py:771 +#, python-format +msgid "invalid numfig_format: %s" +msgstr "" + +#: sphinx/environment/__init__.py:79 +msgid "new config" +msgstr "" + +#: sphinx/environment/__init__.py:80 +msgid "config changed" +msgstr "" + +#: sphinx/environment/__init__.py:81 +msgid "extensions changed" +msgstr "" + +#: sphinx/environment/__init__.py:223 +msgid "build environment version not current" +msgstr "" + +#: sphinx/environment/__init__.py:225 +msgid "source directory has changed" +msgstr "" + +#: sphinx/environment/__init__.py:292 +msgid "" +"This environment is incompatible with the selected builder, please choose" +" another doctree directory." +msgstr "" + +#: sphinx/environment/__init__.py:425 +msgid "document not readable. Ignored." +msgstr "" + +#: sphinx/environment/__init__.py:445 +#, python-format +msgid "Failed to scan documents in %s: %r" +msgstr "" + +#: sphinx/environment/__init__.py:599 +#, python-format +msgid "Domain %r is not registered" +msgstr "" + +#: sphinx/environment/__init__.py:694 +msgid "self referenced toctree found. Ignored." +msgstr "" + +#: sphinx/environment/__init__.py:734 +msgid "document isn't included in any toctree" +msgstr "" + #: sphinx/environment/adapters/indexentries.py:85 #, python-format msgid "see %s" @@ -782,46 +2410,246 @@ msgstr "" msgid "see also %s" msgstr "" -#: sphinx/environment/adapters/indexentries.py:159 +#: sphinx/environment/adapters/indexentries.py:92 +#, python-format +msgid "unknown index entry type %r" +msgstr "" + +#: sphinx/environment/adapters/indexentries.py:159 sphinx/writers/latex.py:673 msgid "Symbols" msgstr "" -#: sphinx/ext/doctest.py:132 +#: sphinx/environment/adapters/toctree.py:151 +#, python-format +msgid "circular toctree references detected, ignoring: %s <- %s" +msgstr "" + +#: sphinx/environment/adapters/toctree.py:170 +#, python-format +msgid "" +"toctree contains reference to document %r that doesn't have a title: no " +"link will be generated" +msgstr "" + +#: sphinx/environment/adapters/toctree.py:175 +#, python-format +msgid "toctree contains reference to nonexisting document %r" +msgstr "" + +#: sphinx/environment/collectors/asset.py:93 +#, python-format +msgid "image file not readable: %s" +msgstr "" + +#: sphinx/environment/collectors/asset.py:109 +#, python-format +msgid "image file %s not readable: %s" +msgstr "" + +#: sphinx/environment/collectors/asset.py:134 +#, python-format +msgid "download file not readable: %s" +msgstr "" + +#: sphinx/environment/collectors/toctree.py:193 +#, python-format +msgid "%s is already assigned section numbers (nested numbered toctree?)" +msgstr "" + +#: sphinx/ext/apidoc.py:74 +#, python-format +msgid "Would create file %s." +msgstr "" + +#: sphinx/ext/apidoc.py:304 +msgid "" +"\n" +"Look recursively in for Python modules and packages and " +"create\n" +"one reST file with automodule directives per package in the " +".\n" +"\n" +"The s can be file and/or directory patterns that will be" +"\n" +"excluded from generation.\n" +"\n" +"Note: By default this script will not overwrite already created files." +msgstr "" + +#: sphinx/ext/apidoc.py:317 +msgid "path to module to document" +msgstr "" + +#: sphinx/ext/apidoc.py:319 +msgid "fnmatch-style file and/or directory patterns to exclude from generation" +msgstr "" + +#: sphinx/ext/apidoc.py:324 +msgid "directory to place all output" +msgstr "" + +#: sphinx/ext/apidoc.py:327 +msgid "maximum depth of submodules to show in the TOC (default: 4)" +msgstr "" + +#: sphinx/ext/apidoc.py:330 +msgid "overwrite existing files" +msgstr "" + +#: sphinx/ext/apidoc.py:333 +msgid "" +"follow symbolic links. Powerful when combined with " +"collective.recipe.omelette." +msgstr "" + +#: sphinx/ext/apidoc.py:336 +msgid "run the script without creating files" +msgstr "" + +#: sphinx/ext/apidoc.py:339 +msgid "put documentation for each module on its own page" +msgstr "" + +#: sphinx/ext/apidoc.py:342 +msgid "include \"_private\" modules" +msgstr "" + +#: sphinx/ext/apidoc.py:344 +msgid "don't create a table of contents file" +msgstr "" + +#: sphinx/ext/apidoc.py:347 +msgid "" +"don't create headings for the module/package packages (e.g. when the " +"docstrings already contain them)" +msgstr "" + +#: sphinx/ext/apidoc.py:352 +msgid "put module documentation before submodule documentation" +msgstr "" + +#: sphinx/ext/apidoc.py:356 +msgid "" +"interpret module paths according to PEP-0420 implicit namespaces " +"specification" +msgstr "" + +#: sphinx/ext/apidoc.py:360 +msgid "file suffix (default: rst)" +msgstr "" + +#: sphinx/ext/apidoc.py:362 +msgid "generate a full project with sphinx-quickstart" +msgstr "" + +#: sphinx/ext/apidoc.py:365 +msgid "append module_path to sys.path, used when --full is given" +msgstr "" + +#: sphinx/ext/apidoc.py:367 +msgid "project name (default: root module name)" +msgstr "" + +#: sphinx/ext/apidoc.py:369 +msgid "project author(s), used when --full is given" +msgstr "" + +#: sphinx/ext/apidoc.py:371 +msgid "project version, used when --full is given" +msgstr "" + +#: sphinx/ext/apidoc.py:373 +msgid "project release, used when --full is given, defaults to --doc-version" +msgstr "" + +#: sphinx/ext/apidoc.py:376 +msgid "extension options" +msgstr "" + +#: sphinx/ext/apidoc.py:403 +#, python-format +msgid "%s is not a directory." +msgstr "" + +#: sphinx/ext/coverage.py:49 +#, python-format +msgid "invalid regex %r in %s" +msgstr "" + +#: sphinx/ext/coverage.py:58 +#, python-format +msgid "" +"Testing of coverage in the sources finished, look at the results in " +"%(outdir)spython.txt." +msgstr "" + +#: sphinx/ext/coverage.py:73 +#, python-format +msgid "invalid regex %r in coverage_c_regexes" +msgstr "" + +#: sphinx/ext/coverage.py:155 +#, python-format +msgid "module %s could not be imported: %s" +msgstr "" + +#: sphinx/ext/doctest.py:143 #, python-format msgid "missing '+' or '-' in '%s' option." msgstr "" -#: sphinx/ext/doctest.py:137 +#: sphinx/ext/doctest.py:148 #, python-format msgid "'%s' is not a valid option." msgstr "" -#: sphinx/ext/doctest.py:151 +#: sphinx/ext/doctest.py:162 #, python-format msgid "'%s' is not a valid pyversion option" msgstr "" -#: sphinx/ext/graphviz.py:136 +#: sphinx/ext/doctest.py:231 +msgid "invalid TestCode type" +msgstr "" + +#: sphinx/ext/doctest.py:292 +#, python-format +msgid "" +"Testing of doctests in the sources finished, look at the results in " +"%(outdir)s/output.txt." +msgstr "" + +#: sphinx/ext/doctest.py:444 +#, python-format +msgid "no code/output in %s block at %s:%s" +msgstr "" + +#: sphinx/ext/doctest.py:535 +#, python-format +msgid "ignoring invalid doctest code: %r" +msgstr "" + +#: sphinx/ext/graphviz.py:139 msgid "Graphviz directive cannot have both content and a filename argument" msgstr "" -#: sphinx/ext/graphviz.py:147 +#: sphinx/ext/graphviz.py:149 #, python-format msgid "External Graphviz file %r not found or reading it failed" msgstr "" -#: sphinx/ext/graphviz.py:153 +#: sphinx/ext/graphviz.py:155 msgid "Ignoring \"graphviz\" directive without content." msgstr "" -#: sphinx/ext/graphviz.py:244 +#: sphinx/ext/graphviz.py:255 #, python-format msgid "" "dot command %r cannot be run (needed for graphviz output), check the " "graphviz_dot setting" msgstr "" -#: sphinx/ext/graphviz.py:262 +#: sphinx/ext/graphviz.py:273 #, python-format msgid "" "dot exited with error:\n" @@ -831,7 +2659,7 @@ msgid "" "%s" msgstr "" -#: sphinx/ext/graphviz.py:265 +#: sphinx/ext/graphviz.py:276 #, python-format msgid "" "dot did not produce an output file:\n" @@ -841,26 +2669,32 @@ msgid "" "%s" msgstr "" -#: sphinx/ext/graphviz.py:276 +#: sphinx/ext/graphviz.py:287 #, python-format msgid "graphviz_output_format must be one of 'png', 'svg', but is %r" msgstr "" -#: sphinx/ext/graphviz.py:377 sphinx/ext/graphviz.py:386 +#: sphinx/ext/graphviz.py:291 sphinx/ext/graphviz.py:345 +#: sphinx/ext/graphviz.py:383 +#, python-format +msgid "dot code %r: %s" +msgstr "" + +#: sphinx/ext/graphviz.py:398 sphinx/ext/graphviz.py:407 #, python-format msgid "[graph: %s]" msgstr "" -#: sphinx/ext/graphviz.py:379 sphinx/ext/graphviz.py:388 +#: sphinx/ext/graphviz.py:400 sphinx/ext/graphviz.py:409 msgid "[graph]" msgstr "" -#: sphinx/ext/imgconverter.py:46 sphinx/ext/imgconverter.py:63 +#: sphinx/ext/imgconverter.py:44 sphinx/ext/imgconverter.py:81 #, python-format msgid "convert command %r cannot be run.check the image_converter setting" msgstr "" -#: sphinx/ext/imgconverter.py:76 +#: sphinx/ext/imgconverter.py:58 sphinx/ext/imgconverter.py:94 #, python-format msgid "" "convert exited with error:\n" @@ -870,171 +2704,318 @@ msgid "" "%s" msgstr "" -#: sphinx/ext/imgmath.py:338 sphinx/ext/jsmath.py:41 sphinx/ext/mathjax.py:42 +#: sphinx/ext/imgmath.py:143 +#, python-format +msgid "" +"LaTeX command %r cannot be run (needed for math display), check the " +"imgmath_latex setting" +msgstr "" + +#: sphinx/ext/imgmath.py:163 +#, python-format +msgid "" +"%s command %r cannot be run (needed for math display), check the " +"imgmath_%s setting" +msgstr "" + +#: sphinx/ext/imgmath.py:302 +#, python-format +msgid "display latex %r: %s" +msgstr "" + +#: sphinx/ext/imgmath.py:329 +#, python-format +msgid "inline latex %r: %s" +msgstr "" + +#: sphinx/ext/imgmath.py:336 sphinx/ext/jsmath.py:47 sphinx/ext/mathjax.py:50 msgid "Permalink to this equation" msgstr "" -#: sphinx/ext/intersphinx.py:339 +#: sphinx/ext/intersphinx.py:226 +#, python-format +msgid "intersphinx identifier %r is not string. Ignored" +msgstr "" + +#: sphinx/ext/intersphinx.py:268 +msgid "failed to reach any of the inventories with the following issues:" +msgstr "" + +#: sphinx/ext/intersphinx.py:343 #, python-format msgid "(in %s v%s)" msgstr "" -#: sphinx/ext/intersphinx.py:341 +#: sphinx/ext/intersphinx.py:345 #, python-format msgid "(in %s)" msgstr "" -#: sphinx/ext/linkcode.py:75 sphinx/ext/viewcode.py:111 +#: sphinx/ext/linkcode.py:75 sphinx/ext/viewcode.py:128 msgid "[source]" msgstr "" -#: sphinx/ext/mathbase.py:124 -#, python-format -msgid "duplicate label of equation %s, other instance in %s" -msgstr "" - #: sphinx/ext/todo.py:67 msgid "Todo" msgstr "" -#: sphinx/ext/todo.py:154 +#: sphinx/ext/todo.py:105 +#, python-format +msgid "TODO entry found: %s" +msgstr "" + +#: sphinx/ext/todo.py:153 msgid "<>" msgstr "" -#: sphinx/ext/todo.py:157 +#: sphinx/ext/todo.py:156 #, python-format msgid "(The <> is located in %s, line %d.)" msgstr "" -#: sphinx/ext/todo.py:166 +#: sphinx/ext/todo.py:165 msgid "original entry" msgstr "" -#: sphinx/ext/viewcode.py:179 +#: sphinx/ext/viewcode.py:196 msgid "[docs]" msgstr "" -#: sphinx/ext/viewcode.py:193 +#: sphinx/ext/viewcode.py:210 msgid "Module code" msgstr "" -#: sphinx/ext/viewcode.py:199 +#: sphinx/ext/viewcode.py:216 #, python-format msgid "

Source code for %s

" msgstr "" -#: sphinx/ext/viewcode.py:225 +#: sphinx/ext/viewcode.py:242 msgid "Overview: module code" msgstr "" -#: sphinx/ext/viewcode.py:226 +#: sphinx/ext/viewcode.py:243 msgid "

All modules for which code is available

" msgstr "" -#: sphinx/ext/autodoc/__init__.py:1120 +#: sphinx/ext/autodoc/__init__.py:345 +#, python-format +msgid "invalid signature for auto%s (%r)" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:444 +#, python-format +msgid "error while formatting arguments for %s: %s" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:566 +#, python-format +msgid "missing attribute %s in object %s" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:654 +#, python-format +msgid "" +"autodoc: failed to determine %r to be documented.the following exception " +"was raised:\n" +"%s" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:746 +#, python-format +msgid "" +"don't know which module to import for autodocumenting %r (try placing a " +"\"module\" or \"currentmodule\" directive in the document, or giving an " +"explicit module name)" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:835 +msgid "\"::\" in automodule name doesn't make sense" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:842 +#, python-format +msgid "signature arguments or return annotation given for automodule %s" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:876 +#, python-format +msgid "" +"__all__ should be a list of strings, not %r (in module %s) -- ignoring " +"__all__" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:889 +#, python-format +msgid "" +"missing attribute mentioned in :members: or __all__: module %s, attribute" +" %s" +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:1134 #, python-format msgid "Bases: %s" msgstr "" -#: sphinx/ext/autodoc/__init__.py:1181 +#: sphinx/ext/autodoc/__init__.py:1195 #, python-format msgid "alias of :class:`%s`" msgstr "" -#: sphinx/ext/napoleon/__init__.py:320 +#: sphinx/ext/autodoc/__init__.py:1541 +msgid "" +"autodoc_default_flags is now deprecated. Please use " +"autodoc_default_options instead." +msgstr "" + +#: sphinx/ext/autodoc/__init__.py:1549 +#, python-format +msgid "Ignoring invalid option in autodoc_default_flags: %r" +msgstr "" + +#: sphinx/ext/autosummary/__init__.py:683 +msgid "" +"autosummary generats .rst files internally. But your source_suffix does " +"not contain .rst. Skipped." +msgstr "" + +#: sphinx/ext/autosummary/generate.py:105 +#, python-format +msgid "[autosummary] generating autosummary for: %s" +msgstr "" + +#: sphinx/ext/autosummary/generate.py:109 +#, python-format +msgid "[autosummary] writing to %s" +msgstr "" + +#: sphinx/ext/autosummary/generate.py:370 +msgid "" +"\n" +"Generate ReStructuredText using autosummary directives.\n" +"\n" +"sphinx-autogen is a frontend to sphinx.ext.autosummary.generate. It " +"generates\n" +"the reStructuredText files from the autosummary directives contained in " +"the\n" +"given input files.\n" +"\n" +"The format of the autosummary directive is documented in the\n" +"``sphinx.ext.autosummary`` Python module and can be read using::\n" +"\n" +" pydoc sphinx.ext.autosummary\n" +msgstr "" + +#: sphinx/ext/autosummary/generate.py:387 +msgid "source files to generate rST files for" +msgstr "" + +#: sphinx/ext/autosummary/generate.py:391 +msgid "directory to place all output in" +msgstr "" + +#: sphinx/ext/autosummary/generate.py:394 +#, python-format +msgid "default suffix for files (default: %(default)s)" +msgstr "" + +#: sphinx/ext/autosummary/generate.py:398 +#, python-format +msgid "custom template directory (default: %(default)s)" +msgstr "" + +#: sphinx/ext/autosummary/generate.py:402 +#, python-format +msgid "document imported members (default: %(default)s)" +msgstr "" + +#: sphinx/ext/napoleon/__init__.py:334 sphinx/ext/napoleon/docstring.py:668 msgid "Keyword Arguments" msgstr "" -#: sphinx/locale/__init__.py:198 +#: sphinx/ext/napoleon/docstring.py:626 +msgid "Example" +msgstr "" + +#: sphinx/ext/napoleon/docstring.py:627 +msgid "Examples" +msgstr "" + +#: sphinx/ext/napoleon/docstring.py:683 +msgid "Notes" +msgstr "" + +#: sphinx/ext/napoleon/docstring.py:687 +msgid "Other Parameters" +msgstr "" + +#: sphinx/ext/napoleon/docstring.py:739 +msgid "References" +msgstr "" + +#: sphinx/ext/napoleon/docstring.py:776 +msgid "Warns" +msgstr "" + +#: sphinx/ext/napoleon/docstring.py:781 +msgid "Yields" +msgstr "" + +#: sphinx/locale/__init__.py:341 msgid "Attention" msgstr "" -#: sphinx/locale/__init__.py:199 +#: sphinx/locale/__init__.py:342 msgid "Caution" msgstr "" -#: sphinx/locale/__init__.py:200 +#: sphinx/locale/__init__.py:343 msgid "Danger" msgstr "" -#: sphinx/locale/__init__.py:201 +#: sphinx/locale/__init__.py:344 msgid "Error" msgstr "" -#: sphinx/locale/__init__.py:202 +#: sphinx/locale/__init__.py:345 msgid "Hint" msgstr "" -#: sphinx/locale/__init__.py:203 +#: sphinx/locale/__init__.py:346 msgid "Important" msgstr "" -#: sphinx/locale/__init__.py:204 +#: sphinx/locale/__init__.py:347 msgid "Note" msgstr "" -#: sphinx/locale/__init__.py:205 +#: sphinx/locale/__init__.py:348 msgid "See also" msgstr "" -#: sphinx/locale/__init__.py:206 +#: sphinx/locale/__init__.py:349 msgid "Tip" msgstr "" -#: sphinx/locale/__init__.py:207 +#: sphinx/locale/__init__.py:350 msgid "Warning" msgstr "" -#: sphinx/locale/__init__.py:211 -#, python-format -msgid "New in version %s" -msgstr "" - -#: sphinx/locale/__init__.py:212 -#, python-format -msgid "Changed in version %s" -msgstr "" - -#: sphinx/locale/__init__.py:213 -#, python-format -msgid "Deprecated since version %s" -msgstr "" - -#: sphinx/locale/__init__.py:219 -msgid "keyword" -msgstr "" - -#: sphinx/locale/__init__.py:220 -msgid "operator" -msgstr "" - -#: sphinx/locale/__init__.py:221 -msgid "object" -msgstr "" - -#: sphinx/locale/__init__.py:223 -msgid "statement" -msgstr "" - -#: sphinx/locale/__init__.py:224 -msgid "built-in function" -msgstr "" - -#: sphinx/templates/latex/longtable.tex_t:18 sphinx/writers/latex.py:711 +#: sphinx/templates/latex/longtable.tex_t:22 sphinx/writers/latex.py:664 msgid "continued from previous page" msgstr "" -#: sphinx/templates/latex/longtable.tex_t:24 +#: sphinx/templates/latex/longtable.tex_t:28 msgid "Continued on next page" msgstr "" #: sphinx/themes/agogo/layout.html:46 sphinx/themes/basic/globaltoc.html:10 -#: sphinx/themes/basic/localtoc.html:11 sphinx/themes/scrolls/layout.html:38 -msgid "Table Of Contents" +#: sphinx/themes/basic/localtoc.html:11 sphinx/themes/scrolls/layout.html:41 +msgid "Table of Contents" msgstr "" -#: sphinx/themes/agogo/layout.html:51 sphinx/themes/basic/layout.html:150 -#: sphinx/themes/basic/search.html:11 sphinx/themes/basic/search.html:23 +#: sphinx/themes/agogo/layout.html:51 sphinx/themes/basic/layout.html:153 +#: sphinx/themes/basic/search.html:11 sphinx/themes/basic/search.html:26 #: sphinx/themes/basic/searchresults.html:10 msgid "Search" msgstr "" @@ -1115,35 +3096,35 @@ msgstr "" msgid "Navigation" msgstr "" -#: sphinx/themes/basic/layout.html:135 +#: sphinx/themes/basic/layout.html:138 #, python-format msgid "Search within %(docstitle)s" msgstr "" -#: sphinx/themes/basic/layout.html:144 +#: sphinx/themes/basic/layout.html:147 msgid "About these documents" msgstr "" -#: sphinx/themes/basic/layout.html:153 +#: sphinx/themes/basic/layout.html:156 msgid "Copyright" msgstr "" -#: sphinx/themes/basic/layout.html:198 +#: sphinx/themes/basic/layout.html:201 #, python-format msgid "© Copyright %(copyright)s." msgstr "" -#: sphinx/themes/basic/layout.html:200 +#: sphinx/themes/basic/layout.html:203 #, python-format msgid "© Copyright %(copyright)s." msgstr "" -#: sphinx/themes/basic/layout.html:204 +#: sphinx/themes/basic/layout.html:207 #, python-format msgid "Last updated on %(last_updated)s." msgstr "" -#: sphinx/themes/basic/layout.html:207 +#: sphinx/themes/basic/layout.html:210 #, python-format msgid "" "Created using Sphinx " @@ -1171,13 +3152,13 @@ msgstr "" msgid "next chapter" msgstr "" -#: sphinx/themes/basic/search.html:27 +#: sphinx/themes/basic/search.html:30 msgid "" "Please activate JavaScript to enable the search\n" " functionality." msgstr "" -#: sphinx/themes/basic/search.html:32 +#: sphinx/themes/basic/search.html:35 msgid "" "From here you can search these documents. Enter your search\n" " words into the box below and click \"search\". Note that the search\n" @@ -1185,17 +3166,17 @@ msgid "" " containing fewer words won't appear in the result list." msgstr "" -#: sphinx/themes/basic/search.html:39 sphinx/themes/basic/searchresults.html:17 +#: sphinx/themes/basic/search.html:42 sphinx/themes/basic/searchresults.html:17 msgid "search" msgstr "" -#: sphinx/themes/basic/search.html:43 sphinx/themes/basic/searchresults.html:21 -#: sphinx/themes/basic/static/searchtools.js_t:298 +#: sphinx/themes/basic/search.html:46 sphinx/themes/basic/searchresults.html:21 +#: sphinx/themes/basic/static/searchtools.js:290 msgid "Search Results" msgstr "" -#: sphinx/themes/basic/search.html:45 sphinx/themes/basic/searchresults.html:23 -#: sphinx/themes/basic/static/searchtools.js_t:300 +#: sphinx/themes/basic/search.html:48 sphinx/themes/basic/searchresults.html:23 +#: sphinx/themes/basic/static/searchtools.js:292 msgid "" "Your search did not match any documents. Please make sure that all words " "are spelled correctly and that you've selected enough categories." @@ -1237,36 +3218,36 @@ msgstr "" msgid "Other changes" msgstr "" -#: sphinx/themes/basic/static/doctools.js_t:193 sphinx/writers/html.py:405 -#: sphinx/writers/html.py:410 sphinx/writers/html5.py:351 -#: sphinx/writers/html5.py:356 +#: sphinx/themes/basic/static/doctools.js:195 sphinx/writers/html.py:403 +#: sphinx/writers/html.py:408 sphinx/writers/html5.py:349 +#: sphinx/writers/html5.py:354 msgid "Permalink to this headline" msgstr "" -#: sphinx/themes/basic/static/doctools.js_t:199 sphinx/writers/html.py:126 -#: sphinx/writers/html.py:137 sphinx/writers/html5.py:95 -#: sphinx/writers/html5.py:106 +#: sphinx/themes/basic/static/doctools.js:201 sphinx/writers/html.py:124 +#: sphinx/writers/html.py:135 sphinx/writers/html5.py:93 +#: sphinx/writers/html5.py:104 msgid "Permalink to this definition" msgstr "" -#: sphinx/themes/basic/static/doctools.js_t:232 +#: sphinx/themes/basic/static/doctools.js:234 msgid "Hide Search Matches" msgstr "" -#: sphinx/themes/basic/static/searchtools.js_t:129 +#: sphinx/themes/basic/static/searchtools.js:121 msgid "Searching" msgstr "" -#: sphinx/themes/basic/static/searchtools.js_t:134 +#: sphinx/themes/basic/static/searchtools.js:126 msgid "Preparing search..." msgstr "" -#: sphinx/themes/basic/static/searchtools.js_t:302 +#: sphinx/themes/basic/static/searchtools.js:294 #, python-format msgid "Search finished, found %s page(s) matching the search query." msgstr "" -#: sphinx/themes/basic/static/searchtools.js_t:355 +#: sphinx/themes/basic/static/searchtools.js:347 msgid ", in " msgstr "" @@ -1283,69 +3264,222 @@ msgstr "" msgid "Contents" msgstr "" -#: sphinx/transforms/post_transforms/__init__.py:139 +#: sphinx/transforms/__init__.py:258 +#, python-format +msgid "4 column based index found. It might be a bug of extensions you use: %r" +msgstr "" + +#: sphinx/transforms/__init__.py:300 +#, python-format +msgid "Footnote [%s] is not referenced." +msgstr "" + +#: sphinx/transforms/__init__.py:306 +msgid "Footnote [#] is not referenced." +msgstr "" + +#: sphinx/transforms/i18n.py:294 sphinx/transforms/i18n.py:371 +msgid "" +"inconsistent footnote references in translated message. original: {0}, " +"translated: {1}" +msgstr "" + +#: sphinx/transforms/i18n.py:340 +msgid "" +"inconsistent references in translated message. original: {0}, translated:" +" {1}" +msgstr "" + +#: sphinx/transforms/i18n.py:393 +msgid "" +"inconsistent citation references in translated message. original: {0}, " +"translated: {1}" +msgstr "" + +#: sphinx/transforms/i18n.py:413 +msgid "" +"inconsistent term references in translated message. original: {0}, " +"translated: {1}" +msgstr "" + +#: sphinx/transforms/post_transforms/__init__.py:142 #, python-format msgid "more than one target found for 'any' cross-reference %r: could be %s" msgstr "" -#: sphinx/transforms/post_transforms/__init__.py:169 +#: sphinx/transforms/post_transforms/__init__.py:172 #, python-format msgid "%s:%s reference target not found: %%(target)s" msgstr "" -#: sphinx/transforms/post_transforms/__init__.py:172 +#: sphinx/transforms/post_transforms/__init__.py:175 #, python-format msgid "%r reference target not found: %%(target)s" msgstr "" -#: sphinx/util/docutils.py:202 +#: sphinx/transforms/post_transforms/images.py:94 +#, python-format +msgid "Could not fetch remote image: %s [%d]" +msgstr "" + +#: sphinx/transforms/post_transforms/images.py:122 +#, python-format +msgid "Could not fetch remote image: %s [%s]" +msgstr "" + +#: sphinx/transforms/post_transforms/images.py:143 +#, python-format +msgid "Unknown image format: %s..." +msgstr "" + +#: sphinx/util/docutils.py:281 msgid "when adding directive classes, no additional arguments may be given" msgstr "" -#: sphinx/writers/html.py:414 sphinx/writers/html5.py:360 +#: sphinx/util/i18n.py:74 +#, python-format +msgid "reading error: %s, %s" +msgstr "" + +#: sphinx/util/i18n.py:81 +#, python-format +msgid "writing error: %s, %s" +msgstr "" + +#: sphinx/util/i18n.py:217 +#, python-format +msgid "" +"Invalid date format. Quote the string by single quote if you want to " +"output it directly: %s" +msgstr "" + +#: sphinx/util/nodes.py:360 +#, python-format +msgid "toctree contains ref to nonexisting file %r" +msgstr "" + +#: sphinx/util/nodes.py:433 +#, python-format +msgid "exception while evaluating only directive expression: %s" +msgstr "" + +#: sphinx/util/rst.py:47 +#, python-format +msgid "default role %s not found" +msgstr "" + +#: sphinx/writers/html.py:336 sphinx/writers/html5.py:304 +#, python-format +msgid "numfig_format is not defined for %s" +msgstr "" + +#: sphinx/writers/html.py:346 sphinx/writers/html5.py:314 +#, python-format +msgid "Any IDs not assigned for %s node" +msgstr "" + +#: sphinx/writers/html.py:412 sphinx/writers/html5.py:358 msgid "Permalink to this table" msgstr "" -#: sphinx/writers/html.py:466 sphinx/writers/html5.py:412 +#: sphinx/writers/html.py:459 sphinx/writers/html5.py:405 msgid "Permalink to this code" msgstr "" -#: sphinx/writers/html.py:470 sphinx/writers/html5.py:416 +#: sphinx/writers/html.py:463 sphinx/writers/html5.py:409 msgid "Permalink to this image" msgstr "" -#: sphinx/writers/html.py:472 sphinx/writers/html5.py:418 +#: sphinx/writers/html.py:465 sphinx/writers/html5.py:411 msgid "Permalink to this toctree" msgstr "" -#: sphinx/writers/latex.py:554 +#: sphinx/writers/html.py:612 sphinx/writers/html5.py:558 +msgid "Could not obtain image size. :scale: option is ignored." +msgstr "" + +#: sphinx/writers/latex.py:508 msgid "Release" msgstr "" -#: sphinx/writers/latex.py:714 +#: sphinx/writers/latex.py:531 +#, python-format +msgid "unknown %r toplevel_sectioning for class %r" +msgstr "" + +#: sphinx/writers/latex.py:582 +#, python-format +msgid "no Babel option known for language %r" +msgstr "" + +#: sphinx/writers/latex.py:633 +msgid "too large :maxdepth:, ignored." +msgstr "" + +#: sphinx/writers/latex.py:667 msgid "continues on next page" msgstr "" -#: sphinx/writers/latex.py:718 +#: sphinx/writers/latex.py:670 +msgid "Non-alphabetical" +msgstr "" + +#: sphinx/writers/latex.py:676 +msgid "Numbers" +msgstr "" + +#: sphinx/writers/latex.py:680 msgid "page" msgstr "" -#: sphinx/writers/latex.py:768 -#, python-format -msgid "Unknown configure key: latex_elements[%r] is ignored." +#: sphinx/writers/latex.py:1013 +msgid "document title is not a single Text node" msgstr "" -#: sphinx/writers/latex.py:1317 sphinx/writers/manpage.py:275 +#: sphinx/writers/latex.py:1046 sphinx/writers/texinfo.py:651 +msgid "encountered title node not in section, topic, table, admonition or sidebar" +msgstr "" + +#: sphinx/writers/latex.py:1223 sphinx/writers/manpage.py:275 #: sphinx/writers/texinfo.py:669 msgid "Footnotes" msgstr "" -#: sphinx/writers/manpage.py:331 sphinx/writers/text.py:713 +#: sphinx/writers/latex.py:1638 +#, python-format +msgid "dimension unit %s is invalid. Ignored." +msgstr "" + +#: sphinx/writers/latex.py:1927 +#, python-format +msgid "unknown index entry type %s found" +msgstr "" + +#: sphinx/writers/latex.py:2606 +#, python-format +msgid "Unknown configure key: latex_elements[%r] is ignored." +msgstr "" + +#: sphinx/writers/manpage.py:331 sphinx/writers/text.py:709 #, python-format msgid "[image: %s]" msgstr "" -#: sphinx/writers/manpage.py:332 sphinx/writers/text.py:714 +#: sphinx/writers/manpage.py:332 sphinx/writers/text.py:710 msgid "[image]" msgstr "" +#: sphinx/writers/texinfo.py:1321 +msgid "caption not inside a figure." +msgstr "" + +#: sphinx/writers/texinfo.py:1412 +#, python-format +msgid "unimplemented node type: %r" +msgstr "" + +#: sphinx/writers/texinfo.py:1417 +#, python-format +msgid "unknown node type: %r" +msgstr "" + From 4fcc64423d9f5200c3abaf33d392e94f5f9780ff Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 21 Aug 2018 01:19:45 +0900 Subject: [PATCH 164/174] Bump version --- CHANGES | 21 +++++++++++++++++++++ sphinx/__init__.py | 6 +++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 529879c74..7b59d857a 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,24 @@ +Release 1.8.0 beta2 (in development) +==================================== + +Dependencies +------------ + +Incompatible changes +-------------------- + +Deprecated +---------- + +Features added +-------------- + +Bugs fixed +---------- + +Testing +-------- + Release 1.8.0 beta1 (in development) ==================================== diff --git a/sphinx/__init__.py b/sphinx/__init__.py index ab1087194..1309996bc 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -37,8 +37,8 @@ if 'PYTHONWARNINGS' not in os.environ: warnings.filterwarnings('ignore', "'U' mode is deprecated", DeprecationWarning, module='docutils.io') -__version__ = '1.8.0b1' -__released__ = '1.8.0b1' # used when Sphinx builds its own docs +__version__ = '1.8.0+' +__released__ = '1.8.0' # used when Sphinx builds its own docs #: Version info for better programmatic use. #: @@ -48,7 +48,7 @@ __released__ = '1.8.0b1' # used when Sphinx builds its own docs #: #: .. versionadded:: 1.2 #: Before version 1.2, check the string ``sphinx.__version__``. -version_info = (1, 8, 0, 'beta', 1) +version_info = (1, 8, 0, 'beta', 2) package_dir = path.abspath(path.dirname(__file__)) From 3dcbe14c6fb8437f1cfb05cb9f267550e9e38717 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 21 Aug 2018 01:20:56 +0900 Subject: [PATCH 165/174] Bump version --- CHANGES | 21 +++++++++++++++++++++ sphinx/__init__.py | 6 +++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 7b59d857a..43e78604d 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,24 @@ +Release 2.0.0 (in development) +============================== + +Dependencies +------------ + +Incompatible changes +-------------------- + +Deprecated +---------- + +Features added +-------------- + +Bugs fixed +---------- + +Testing +-------- + Release 1.8.0 beta2 (in development) ==================================== diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 1309996bc..e68863a8b 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -37,8 +37,8 @@ if 'PYTHONWARNINGS' not in os.environ: warnings.filterwarnings('ignore', "'U' mode is deprecated", DeprecationWarning, module='docutils.io') -__version__ = '1.8.0+' -__released__ = '1.8.0' # used when Sphinx builds its own docs +__version__ = '2.0.0+' +__released__ = '2.0.0' # used when Sphinx builds its own docs #: Version info for better programmatic use. #: @@ -48,7 +48,7 @@ __released__ = '1.8.0' # used when Sphinx builds its own docs #: #: .. versionadded:: 1.2 #: Before version 1.2, check the string ``sphinx.__version__``. -version_info = (1, 8, 0, 'beta', 2) +version_info = (2, 0, 0, 'beta', 0) package_dir = path.abspath(path.dirname(__file__)) From 00f476040e30371044437860ef07cb023b94489a Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 21 Aug 2018 21:59:16 +0900 Subject: [PATCH 166/174] graphviz: Don't use document.current_source --- sphinx/ext/graphviz.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index a702e6045..cf606f3b7 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -156,9 +156,7 @@ class Graphviz(SphinxDirective): line=self.lineno)] node = graphviz() node['code'] = dotcode - node['options'] = { - 'docname': path.splitext(self.state.document.current_source)[0], - } + node['options'] = {'docname': self.env.docname} if 'graphviz_dot' in self.options: node['options']['graphviz_dot'] = self.options['graphviz_dot'] From 472001eeb754a2389740115de53ae0c129a5eca0 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 22 Aug 2018 11:08:33 +0900 Subject: [PATCH 167/174] Fix typo --- doc/usage/extensions/autodoc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 97ac51903..d33378435 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -362,7 +362,7 @@ There are also new config values that you can set: .. confval:: autodoc_default_options The default options for autodoc directives. They are applied to all autodoc - directives automatically. It must be a dictionally which maps option names + directives automatically. It must be a dictionary which maps option names to the values. For example:: autodoc_default_options = { From 59bc1da6aede3b1ffc6d09fc3f4c6c26ff3788e0 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 22 Aug 2018 14:33:48 +0900 Subject: [PATCH 168/174] Fix html: search box overrides to other elements if scrolled --- CHANGES | 2 ++ sphinx/themes/basic/static/basic.css_t | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/CHANGES b/CHANGES index 7b59d857a..1d851a424 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,8 @@ Features added Bugs fixed ---------- +* html: search box overrides to other elements if scrolled + Testing -------- diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index cab3a342b..94a8fa888 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -81,6 +81,10 @@ div.sphinxsidebar input { font-size: 1em; } +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + div.sphinxsidebar #searchbox input[type="text"] { float: left; width: 80%; From bde53bf9fbdf612a48adf377c15c03a5e31113da Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 22 Aug 2018 15:28:16 +0900 Subject: [PATCH 169/174] Fix #5320: intersphinx: crashed if invalid url given --- CHANGES | 2 ++ sphinx/ext/intersphinx.py | 21 +++++++++++++-------- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/CHANGES b/CHANGES index 5f6bbaf8d..94f7fce05 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,8 @@ Features added Bugs fixed ---------- +* #5320: intersphinx: crashed if invalid url given + Testing -------- diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index 372f7baab..88e9997eb 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -403,14 +403,19 @@ def inspect_main(argv): def warn(self, msg): print(msg, file=sys.stderr) - filename = argv[0] - invdata = fetch_inventory(MockApp(), '', filename) # type: ignore - for key in sorted(invdata or {}): - print(key) - for entry, einfo in sorted(invdata[key].items()): - print('\t%-40s %s%s' % (entry, - einfo[3] != '-' and '%-40s: ' % einfo[3] or '', - einfo[2])) + try: + filename = argv[0] + invdata = fetch_inventory(MockApp(), '', filename) # type: ignore + for key in sorted(invdata or {}): + print(key) + for entry, einfo in sorted(invdata[key].items()): + print('\t%-40s %s%s' % (entry, + einfo[3] != '-' and '%-40s: ' % einfo[3] or '', + einfo[2])) + except ValueError as exc: + print(exc.args[0] % exc.args[1:]) + except Exception as exc: + print('Unknown error: %r' % exc) if __name__ == '__main__': From 32ba1120919ed5455c7f69a415a07c95bd25de3f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 22 Aug 2018 18:17:54 +0900 Subject: [PATCH 170/174] Fix #5325: latex: cross references has been broken by multiply labeled objects --- CHANGES | 2 ++ sphinx/writers/latex.py | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 7b59d857a..e4b7ebc86 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,8 @@ Features added Bugs fixed ---------- +* #5325: latex: cross references has been broken by multiply labeled objects + Testing -------- diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 7bd441e26..cd222f1c7 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -1858,8 +1858,11 @@ class LaTeXTranslator(nodes.NodeVisitor): self.body.append(self.hypertarget(id, anchor=anchor)) # skip if visitor for next node supports hyperlink + next_node = node + while isinstance(next_node, nodes.target): + next_node = next_node.next_node(ascend=True) + domain = self.builder.env.get_domain('std') - next_node = node.next_node(ascend=True) if isinstance(next_node, HYPERLINK_SUPPORT_NODES): return elif domain.get_enumerable_node_type(next_node) and domain.get_numfig_title(next_node): From 59a766d7d69d072ee5cf90455f52ff0d169b4442 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 21 Aug 2018 20:05:17 +0900 Subject: [PATCH 171/174] Fix #5322: autodoc: ``Any`` typehint causes formatting error --- CHANGES | 2 ++ sphinx/util/inspect.py | 4 +++- tests/test_util_inspect.py | 6 +++++- tests/typing_test_data.py | 6 +++++- 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 5f6bbaf8d..798187983 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,8 @@ Features added Bugs fixed ---------- +* #5322: autodoc: ``Any`` typehint causes formatting error + Testing -------- diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 3b5d48e2a..bab88eb88 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -531,8 +531,10 @@ class Signature(object): qualname = annotation.__qualname__ elif getattr(annotation, '__forward_arg__', None): qualname = annotation.__forward_arg__ - else: + elif getattr(annotation, '__origin__', None): qualname = self.format_annotation(annotation.__origin__) # ex. Union + else: + qualname = repr(annotation).replace('typing.', '') elif hasattr(annotation, '__qualname__'): qualname = '%s.%s' % (module, annotation.__qualname__) else: diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index a48aedcf0..928a45621 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -232,7 +232,7 @@ def test_Signature_partialmethod(): reason='type annotation test is available on py34 or above') def test_Signature_annotations(): from typing_test_data import ( - f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, Node) + f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, Node) # Class annotations sig = inspect.Signature(f0).format_args() @@ -293,6 +293,10 @@ def test_Signature_annotations(): sig = inspect.Signature(f13).format_args() assert sig == '() -> Optional[str]' + # Any + sig = inspect.Signature(f14).format_args() + assert sig == '() -> Any' + # type hints by string sig = inspect.Signature(Node.children).format_args() assert sig == '(self) -> List[typing_test_data.Node]' diff --git a/tests/typing_test_data.py b/tests/typing_test_data.py index 5b161eac4..4dc2d06f5 100644 --- a/tests/typing_test_data.py +++ b/tests/typing_test_data.py @@ -1,5 +1,5 @@ from numbers import Integral -from typing import List, TypeVar, Union, Callable, Tuple, Optional +from typing import Any, List, TypeVar, Union, Callable, Tuple, Optional def f0(x: int, y: Integral) -> None: @@ -72,6 +72,10 @@ def f13() -> Optional[str]: pass +def f14() -> Any: + pass + + class Node: def __init__(self, parent: Optional['Node']) -> None: pass From ee604144c6ad09979820647e938138ad021e62b0 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 22 Aug 2018 19:48:43 +0900 Subject: [PATCH 172/174] Fix #5326: manpage: crashed when invalid docname is specified as ``man_pages`` --- CHANGES | 3 +++ sphinx/builders/manpage.py | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/CHANGES b/CHANGES index 5f6bbaf8d..275a895ef 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,9 @@ Features added Bugs fixed ---------- +* #5326: manpage: crashed when invalid docname is specified as ``man_pages`` + + Testing -------- diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 7a691ccf0..03462be6b 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -18,6 +18,7 @@ from six import string_types from sphinx import addnodes from sphinx.builders import Builder from sphinx.environment import NoUri +from sphinx.locale import __ from sphinx.util import logging from sphinx.util.console import bold, darkgreen # type: ignore from sphinx.util.nodes import inline_all_toctrees @@ -72,6 +73,10 @@ class ManualPageBuilder(Builder): for info in self.config.man_pages: docname, name, description, authors, section = info + if docname not in self.env.all_docs: + logger.warning(__('"man_pages" config value references unknown ' + 'document %s'), docname) + continue if isinstance(authors, string_types): if authors: authors = [authors] From 520797a5e8c52f9bdcdcf8cd85484b4c7d0ed21f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 25 Aug 2018 02:21:39 +0900 Subject: [PATCH 173/174] test: Upgrade python on Circle CI to 3.5 --- .circleci/config.yml | 6 +++--- tests/test_util_inspect.py | 5 ++++- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index f4d4415f1..d349db6e0 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -6,6 +6,6 @@ jobs: working_directory: /sphinx steps: - checkout - - run: /python3.4/bin/pip install -U pip setuptools - - run: /python3.4/bin/pip install -U .[test,websupport] - - run: make test PYTHON=/python3.4/bin/python + - run: /python3.5/bin/pip install -U pip setuptools + - run: /python3.5/bin/pip install -U .[test,websupport] + - run: make test PYTHON=/python3.5/bin/python diff --git a/tests/test_util_inspect.py b/tests/test_util_inspect.py index 928a45621..eddca6241 100644 --- a/tests/test_util_inspect.py +++ b/tests/test_util_inspect.py @@ -299,7 +299,10 @@ def test_Signature_annotations(): # type hints by string sig = inspect.Signature(Node.children).format_args() - assert sig == '(self) -> List[typing_test_data.Node]' + if (3, 5, 0) <= sys.version_info < (3, 5, 3): + assert sig == '(self) -> List[Node]' + else: + assert sig == '(self) -> List[typing_test_data.Node]' sig = inspect.Signature(Node.__init__).format_args() assert sig == '(self, parent: Optional[Node]) -> None' From a3ae0ef6caeb8f9127a469cd1dcd7ab98629acd2 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 25 Aug 2018 10:20:53 +0900 Subject: [PATCH 174/174] autodoc: Fix typing.get_type_hints() raises AttributeError for partial objects --- sphinx/util/inspect.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index f4c3461ea..1d038747b 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -360,8 +360,13 @@ class Signature(object): try: self.annotations = typing.get_type_hints(subject) # type: ignore except Exception as exc: - logger.warning('Invalid type annotation found on %r. Ingored: %r', subject, exc) - self.annotations = {} + if (3, 5, 0) <= sys.version_info < (3, 5, 3) and isinstance(exc, AttributeError): + # python 3.5.2 raises ValueError for partial objects. + self.annotations = {} + else: + logger.warning('Invalid type annotation found on %r. Ingored: %r', + subject, exc) + self.annotations = {} if bound_method: # client gives a hint that the subject is a bound method