diff -Nru sphinx-automodapi-0.12/azure-pipelines.yml sphinx-automodapi-0.13/azure-pipelines.yml --- sphinx-automodapi-0.12/azure-pipelines.yml 2019-08-10 09:30:26.000000000 +0000 +++ sphinx-automodapi-0.13/azure-pipelines.yml 1970-01-01 00:00:00.000000000 +0000 @@ -1,24 +0,0 @@ -schedules: -- cron: '0 8 1 * *' - displayName: 'Monthly cron' - branches: - include: - - master - always: 'true' - -jobs: - -- template: azure-template.yml - parameters: - name: Linux - os: linux - -- template: azure-template.yml - parameters: - name: MacOSX - os: macosx - -- template: azure-template.yml - parameters: - name: Windows - os: windows diff -Nru sphinx-automodapi-0.12/azure-template.yml sphinx-automodapi-0.13/azure-template.yml --- sphinx-automodapi-0.12/azure-template.yml 2019-08-09 07:50:13.000000000 +0000 +++ sphinx-automodapi-0.13/azure-template.yml 1970-01-01 00:00:00.000000000 +0000 @@ -1,58 +0,0 @@ -jobs: -- job: ${{ format(parameters.name) }} - pool: - ${{ if eq(parameters.os, 'macosx') }}: - vmImage: macOS 10.13 - ${{ if eq(parameters.os, 'linux') }}: - vmImage: Ubuntu 16.04 - ${{ if eq(parameters.os, 'windows') }}: - vmImage: vs2017-win2016 - - steps: - - - ${{ if eq(parameters.os, 'macosx') }}: - - script: brew install graphviz - displayName: Installing graphviz - - ${{ if eq(parameters.os, 'linux') }}: - - script: sudo apt-get install -y graphviz - displayName: Installing graphviz - - ${{ if eq(parameters.os, 'windows') }}: - - script: choco install graphviz vcpython27 curl codecov --no-progress - displayName: Installing graphviz, vcpython27, curl, and codecov - - - task: UsePythonVersion@0 - inputs: - versionSpec: '2.7' - architecture: 'x64' - - - task: UsePythonVersion@0 - inputs: - versionSpec: '3.5' - architecture: 'x64' - - - task: UsePythonVersion@0 - inputs: - versionSpec: '3.6' - architecture: 'x64' - - - task: UsePythonVersion@0 - inputs: - versionSpec: '3.7' - architecture: 'x64' - - - script: pip install tox coverage - displayName: Installing tox and coverage - - - script: tox - displayName: Running tests with tox - - - bash: coverage combine .tmp/*/.coverage - displayName: Combining coverage results - - bash: coverage report - displayName: Show coverage - - # As described in https://github.com/codecov/codecov-bash/issues/189, the - # official bash script doesn't use the correct variable names for pull - # requests, so we use a fork of the bash script for now. - - bash: bash <(curl https://raw.githubusercontent.com/astrofrog/codecov-bash/fixed-azure/codecov) -t $(codecov.token) - displayName: Uploading results to codecov diff -Nru sphinx-automodapi-0.12/CHANGES.rst sphinx-automodapi-0.13/CHANGES.rst --- sphinx-automodapi-0.12/CHANGES.rst 2019-08-15 10:14:04.000000000 +0000 +++ sphinx-automodapi-0.13/CHANGES.rst 2020-09-24 20:40:41.000000000 +0000 @@ -1,6 +1,18 @@ Changes in sphinx-automodapi ============================ +0.13 (2020-09-24) +----------------- + +- Fixed implementation of ``allowed-package-names`` option (which did + not work at all). [#111] + +- Ensure that generated files are always in .rst. [#112] + +- Update minimum required Python version to 3.6. [#117] + +- Fixed compatibility with Sphinx 3.0 and later. [#100] + 0.12 (2019-08-15) ----------------- diff -Nru sphinx-automodapi-0.12/.coveragerc sphinx-automodapi-0.13/.coveragerc --- sphinx-automodapi-0.12/.coveragerc 2019-08-09 07:50:13.000000000 +0000 +++ sphinx-automodapi-0.13/.coveragerc 1970-01-01 00:00:00.000000000 +0000 @@ -1,12 +0,0 @@ -[run] -source = sphinx_automodapi -omit = */tests/* - -[paths] -source = - sphinx_automodapi/ - */site-packages/sphinx_automodapi - *\site-packages\sphinx_automodapi - -[report] -omit = */tests/* diff -Nru sphinx-automodapi-0.12/debian/changelog sphinx-automodapi-0.13/debian/changelog --- sphinx-automodapi-0.12/debian/changelog 2019-09-23 12:46:22.000000000 +0000 +++ sphinx-automodapi-0.13/debian/changelog 2020-09-25 07:28:56.000000000 +0000 @@ -1,3 +1,19 @@ +sphinx-automodapi (0.13-1) unstable; urgency=medium + + [ Ondřej Nový ] + * d/control: Update Maintainer field with new Debian Python Team + contact address. + * d/control: Update Vcs-* fields with new Debian Python Team Salsa + layout. + + [ Ole Streicher ] + * New upstream version 0.13. Rediff patches + * Push Standards-Version to 4.5.0. No changes needed + * Push dh-compat to 13 + * Add "Rules-Requires-Root: no" to d/control + + -- Ole Streicher Fri, 25 Sep 2020 09:28:56 +0200 + sphinx-automodapi (0.12-2) unstable; urgency=low * Add grapviz to Recommends and as test dependency diff -Nru sphinx-automodapi-0.12/debian/control sphinx-automodapi-0.13/debian/control --- sphinx-automodapi-0.12/debian/control 2019-09-23 12:00:15.000000000 +0000 +++ sphinx-automodapi-0.13/debian/control 2020-09-25 07:28:56.000000000 +0000 @@ -1,19 +1,20 @@ Source: sphinx-automodapi Section: python Priority: optional -Maintainer: Debian Python Team +Maintainer: Debian Python Team Uploaders: Ole Streicher Build-Depends: cython3, - debhelper-compat (= 12), + debhelper-compat (= 13), dh-python, - python3-all-dev, + python3-all, python3-pytest, python3-setuptools, python3-sphinx -Standards-Version: 4.4.0 +Standards-Version: 4.5.0 Homepage: https://astropy.org -Vcs-Browser: https://salsa.debian.org/python-team/modules/sphinx-automodapi -Vcs-Git: https://salsa.debian.org/python-team/modules/sphinx-automodapi.git +Vcs-Browser: https://salsa.debian.org/python-team/packages/sphinx-automodapi +Vcs-Git: https://salsa.debian.org/python-team/packages/sphinx-automodapi.git +Rules-Requires-Root: no Package: python3-sphinx-automodapi Architecture: all diff -Nru sphinx-automodapi-0.12/debian/patches/Remove-intersphinx-mapping-in-test.patch sphinx-automodapi-0.13/debian/patches/Remove-intersphinx-mapping-in-test.patch --- sphinx-automodapi-0.12/debian/patches/Remove-intersphinx-mapping-in-test.patch 2019-09-17 10:45:41.000000000 +0000 +++ sphinx-automodapi-0.13/debian/patches/Remove-intersphinx-mapping-in-test.patch 2020-09-25 07:27:00.000000000 +0000 @@ -12,7 +12,7 @@ 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/sphinx_automodapi/tests/test_cases.py b/sphinx_automodapi/tests/test_cases.py -index 0e3583c..859ca74 100644 +index 72f6140..cd7078e 100644 --- a/sphinx_automodapi/tests/test_cases.py +++ b/sphinx_automodapi/tests/test_cases.py @@ -26,7 +26,6 @@ PARALLEL = {False, True} @@ -23,7 +23,7 @@ } DEFAULT_CONF = {'source_suffix': '.rst', -@@ -92,7 +91,7 @@ def test_run_full_case(tmpdir, case_dir, parallel): +@@ -93,7 +92,7 @@ def test_run_full_case(tmpdir, case_dir, parallel): input_file = os.path.join(root, filename) shutil.copy(input_file, root_dir) diff -Nru sphinx-automodapi-0.12/docs/automodapi.rst sphinx-automodapi-0.13/docs/automodapi.rst --- sphinx-automodapi-0.12/docs/automodapi.rst 2018-01-29 15:18:51.000000000 +0000 +++ sphinx-automodapi-0.13/docs/automodapi.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,32 +0,0 @@ -Automatically generating module documentation with automodapi -============================================================= - -.. _automodapi: - -Overview --------- - -The main Sphinx directive provided by the sphinx-automodapi package is the -``automodapi`` directive. As described in the :ref:`quickstart` guide, -before you use the directive, you will need to make sure the following -extension is included in the ``extensions`` entry of your documentation's -``conf.py`` file:: - - extensions = ['sphinx_automodapi.automodapi'] - -You can then add an ``automodapi`` block anywhere that you want to generate -documentation for a module:: - - .. automodapi:: mypackage.mymodule - - -This will add a section with the docstring of the module, followed by a list of -functions, and by a list of classes. For each function and class, a full API -page will be generated. - -The automodapi directive and allowed options are described in more detail below. - -In detail ---------- - -.. automodule:: sphinx_automodapi.automodapi diff -Nru sphinx-automodapi-0.12/docs/automodsumm.rst sphinx-automodapi-0.13/docs/automodsumm.rst --- sphinx-automodapi-0.12/docs/automodsumm.rst 2018-01-29 15:18:51.000000000 +0000 +++ sphinx-automodapi-0.13/docs/automodsumm.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,27 +0,0 @@ -Generating tables of module objects with automodsumm -==================================================== - -.. _automodsumm: - -Overview --------- - -The ``automodsumm`` directive takes all objects in a -module and generates a table of these objects and associated API pages. The -:ref:`automodapi ` directive then calls ``automodsumm`` once for -functions and once for classes, and adds the module docstring - but effectively, -the bulk of the work in creating the API tables and pages is done by -``automodsumm``. - -Nevertheless, in most cases, users should not need to call ``automodsumm`` -directly, except if finer control is desired. The syntax of the directive is:: - - .. automodsumm:: mypackage.mymodule - - -The automodsumm directive is described in more detail below. - -In detail ---------- - -.. automodule:: sphinx_automodapi.automodsumm diff -Nru sphinx-automodapi-0.12/docs/conf.py sphinx-automodapi-0.13/docs/conf.py --- sphinx-automodapi-0.12/docs/conf.py 2019-08-15 10:14:38.000000000 +0000 +++ sphinx-automodapi-0.13/docs/conf.py 1970-01-01 00:00:00.000000000 +0000 @@ -1,59 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# -- General configuration ------------------------------------------------ - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinx.ext.autosummary'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'sphinx-automodapi' -copyright = '2016, The Astropy Developers' -author = 'The Astropy Developers' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.12' -# The full version, including alpha/beta/rc tags. -release = version - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'sphinx_rtd_theme' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'sphinx-automodapidoc' - -nitpicky = True diff -Nru sphinx-automodapi-0.12/docs/index.rst sphinx-automodapi-0.13/docs/index.rst --- sphinx-automodapi-0.12/docs/index.rst 2019-08-15 10:12:55.000000000 +0000 +++ sphinx-automodapi-0.13/docs/index.rst 1970-01-01 00:00:00.000000000 +0000 @@ -1,81 +0,0 @@ -Documentation for sphinx-automodapi -=================================== - -The sphinx-automodapi package provides Sphinx directives that help faciliate -the automatic generation of API documentation pages for Python package modules. -It was originally developped for the Astropy project, but is now developed as a -standalone package that can be used for any project. - -Installation ------------- - -This extension requires Sphinx 1.7 or later, and can be installed with:: - - pip install sphinx-automodapi - -The extension is also available through conda package management system. It can be installed with:: - - conda install -c astropy sphinx-automodapi - - - -.. _quickstart: - -Quick start ------------ - -To use this extension, you will need to add the following entry to the -``extensions`` list in your Sphinx ``conf.py`` file:: - - extensions = ['sphinx_automodapi.automodapi'] - numpydoc_show_class_members = False - -You can then add an ``automodapi`` block anywhere that you want to generate -documentation for a module:: - - .. automodapi:: mypackage.mymodule - -This will add a section with the docstring of the module, followed by a list of -functions, and by a list of classes. For each function and class, a full API -page will be generated. The ``numpydoc_show_class_members=False`` option is needed -to avoid having methods and attributes of classes being shown multiple times. - -By default, sphinx_automodapi will try and make a diagram showing an -inheritance graph of all the classes in the module. This requires graphviz to -be installed. To disable the inheritance diagram, you can do:: - - .. automodapi:: mypackage.mymodule - :no-inheritance-diagram: - -The ``automodapi`` directive takes other options that are described in more -detail in the `User guide`_ below. - -If you are documenting a module which imports classes from other files, and you -want to include an inheritance diagram for the classes, you may run into Sphinx -warnings, because the class may be documented as e.g. ``astropy.table.Table`` -but the class really lives at ``astropy.table.core.Table``. To fix this you can -make use of the ``'sphinx_automodapi.smart_resolver'`` Sphinx extension, which -will automatically try and resolve such differences. In this, case, be sure to -include:: - - extensions = ['sphinx_automodapi.automodapi', - 'sphinx_automodapi.smart_resolver'] - -in your ``conf.py`` file. - -User guide ----------- - -.. toctree:: - :maxdepth: 1 - - automodapi.rst - automodsumm.rst - -Dependency Version Guidelines ------------------------------ - -As a general guideline, automodapi dependencies (at the time of writing, just -Sphinx) aim to maintain compatibility with versions <= 2 years old. Dependencies -may be newer, however, if specific features become important to help automodapi -work better or be more maintainable. diff -Nru sphinx-automodapi-0.12/docs/Makefile sphinx-automodapi-0.13/docs/Makefile --- sphinx-automodapi-0.12/docs/Makefile 2018-01-29 15:18:51.000000000 +0000 +++ sphinx-automodapi-0.13/docs/Makefile 1970-01-01 00:00:00.000000000 +0000 @@ -1,225 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " epub3 to make an epub3" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - @echo " dummy to check syntax errors of document sources" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sphinx-automodapi.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinx-automodapi.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/sphinx-automodapi" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinx-automodapi" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: epub3 -epub3: - $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 - @echo - @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - -.PHONY: dummy -dummy: - $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy - @echo - @echo "Build finished. Dummy builder generates no files." diff -Nru sphinx-automodapi-0.12/.gitignore sphinx-automodapi-0.13/.gitignore --- sphinx-automodapi-0.12/.gitignore 2018-01-29 15:18:51.000000000 +0000 +++ sphinx-automodapi-0.13/.gitignore 1970-01-01 00:00:00.000000000 +0000 @@ -1,51 +0,0 @@ -# Compiled files -*.py[cod] -*.a -*.o -*.so -*.pyd -__pycache__ - -# Ignore .c files by default to avoid including generated code. If you want to -# add a non-generated .c extension, use `git add -f filename.c`. -*.c - -# Other generated files -MANIFEST - -# Sphinx -_build -_generated - - -# Packages/installer info -*.egg -*.egg-info -dist -build -eggs -parts -bin -var -sdist -develop-eggs -.installed.cfg -distribute-*.tar.gz - -# Other -.cache -.tox -.*.swp -*~ -.project -.pydevproject -.settings -.coverage -cover -htmlcov - -# Mac OSX -.DS_Store - -# PyCharm -.idea diff -Nru sphinx-automodapi-0.12/PKG-INFO sphinx-automodapi-0.13/PKG-INFO --- sphinx-automodapi-0.12/PKG-INFO 2019-08-15 10:17:25.000000000 +0000 +++ sphinx-automodapi-0.13/PKG-INFO 2020-09-24 20:43:08.275892700 +0000 @@ -1,6 +1,6 @@ Metadata-Version: 2.1 Name: sphinx-automodapi -Version: 0.12 +Version: 0.13 Summary: Sphinx extension for auto-generating API documentation for entire modules Home-page: http://astropy.org Author: The Astropy Developers @@ -43,4 +43,5 @@ Classifier: Programming Language :: Python :: 3 Classifier: Operating System :: OS Independent Classifier: License :: OSI Approved :: BSD License +Requires-Python: >=3.6 Provides-Extra: test diff -Nru sphinx-automodapi-0.12/setup.cfg sphinx-automodapi-0.13/setup.cfg --- sphinx-automodapi-0.12/setup.cfg 2019-08-15 10:17:25.000000000 +0000 +++ sphinx-automodapi-0.13/setup.cfg 2020-09-24 20:43:08.278966400 +0000 @@ -19,6 +19,7 @@ [options] zip_safe = False packages = find: +python_requires = >=3.6 install_requires = sphinx>=1.7 @@ -28,7 +29,7 @@ pytest-cov cython codecov - coverage + coverage < 5.0 [options.package_data] sphinx_automodapi = templates/*/*.rst diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/automodapi.py sphinx-automodapi-0.13/sphinx_automodapi/automodapi.py --- sphinx-automodapi-0.12/sphinx_automodapi/automodapi.py 2019-08-15 10:12:55.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/automodapi.py 2020-09-24 20:38:30.000000000 +0000 @@ -166,7 +166,7 @@ def automodapi_replace(sourcestr, app, dotoctree=True, docname=None, warnings=True): """ - Replaces `sourcestr`'s entries of ".. automdapi::" with the + Replaces `sourcestr`'s entries of ".. automodapi::" with the automodapi template form based on provided options. This is used with the sphinx event 'source-read' to replace @@ -256,7 +256,7 @@ elif opname == 'no-heading': top_head = False elif opname == 'allowed-package-names': - allowedpkgnms.append(args.strip()) + allowedpkgnms.extend(arg.strip() for arg in args.split(',')) elif opname == 'inherited-members': inherited_members = True elif opname == 'no-inherited-members': @@ -271,8 +271,8 @@ allowedpkgnms = '' onlylocals = True else: - allowedpkgnms = ':allowed-package-names: ' + ','.join(allowedpkgnms) onlylocals = allowedpkgnms + allowedpkgnms = ':allowed-package-names: ' + ','.join(allowedpkgnms) # get the two heading chars hds = hds.strip() diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/automodsumm.py sphinx-automodapi-0.13/sphinx_automodapi/automodsumm.py --- sphinx-automodapi-0.12/sphinx_automodapi/automodsumm.py 2019-08-15 10:12:55.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/automodsumm.py 2020-09-24 20:38:30.000000000 +0000 @@ -264,11 +264,10 @@ f.write('\n') for sfn, lines in zip(filestosearch, liness): - suffix = os.path.splitext(sfn)[1] if len(lines) > 0: generate_automodsumm_docs( lines, sfn, app=app, builder=app.builder, - suffix=suffix, base_path=app.srcdir, + base_path=app.srcdir, inherited_members=app.config.automodsumm_inherited_members) diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/__init__.py sphinx-automodapi-0.13/sphinx_automodapi/__init__.py --- sphinx-automodapi-0.12/sphinx_automodapi/__init__.py 2019-08-15 10:14:43.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/__init__.py 2020-09-24 20:41:36.000000000 +0000 @@ -1 +1 @@ -__version__ = '0.12' +__version__ = '0.13' diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/smart_resolver.py sphinx-automodapi-0.13/sphinx_automodapi/smart_resolver.py --- sphinx-automodapi-0.12/sphinx_automodapi/smart_resolver.py 2019-08-09 07:50:13.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/smart_resolver.py 2020-09-24 20:38:30.000000000 +0000 @@ -34,6 +34,37 @@ def missing_reference_handler(app, env, node, contnode): + """ + Handler to be connect to the sphinx 'missing-reference' event. The handler a + resolves reference (node) and returns a new node when sphinx could not + originally resolve the reference. + + see `missing-reference in sphinx documentation + `_ + + :param app: The Sphinx application object + :param env: The build environment (``app.builder.env`) + :param node: The ``pending_xref`` node to be resolved. Its attributes reftype, + reftarget, modname and classname attributes determine the type and + target of the reference. + :param contnode: The node that carries the text and formatting inside the + future reference and should be a child of the returned + reference node. + """ + # a good example of how a missing reference handle works look to + # https://github.com/sphinx-doc/sphinx/issues/1572#issuecomment-68590981 + # + # Important attributes of the "node": + # + # example role: :ref:`title ` + # + # 'reftype' - role name (in the example above 'ref' is the reftype) + # 'reftarget' - target of the role, as given in the role content + # (in the example 'target' is the reftarget + # 'refexplicit' - the explicit title of the role + # (in the example 'title' is the refexplicit) + # 'refdoc' - document in which the role appeared + # 'refdomain' - domain of the role, in our case emtpy if not hasattr(env, 'class_name_mapping'): env.class_name_mapping = {} @@ -41,13 +72,15 @@ reftype = node['reftype'] reftarget = node['reftarget'] + refexplicit = node.get('refexplicit') # default: None + refdoc = node.get('refdoc', env.docname) if reftype in ('obj', 'class', 'exc', 'meth'): - reftarget = node['reftarget'] suffix = '' if reftarget not in mapping: if '.' in reftarget: front, suffix = reftarget.rsplit('.', 1) else: + front = None suffix = reftarget if suffix.startswith('_') and not suffix.startswith('__'): @@ -56,7 +89,7 @@ # nitpick warning. return node[0].deepcopy() - if reftype in ('obj', 'meth') and '.' in reftarget: + if reftype in ('obj', 'meth') and front is not None: if front in mapping: reftarget = front suffix = '.' + suffix @@ -73,10 +106,10 @@ if (reftarget not in mapping and prefix in inventory): - if 'py:class' in inventory[prefix] and reftarget in inventory[prefix]['py:class']: + if 'py:class' in inventory[prefix] and \ + reftarget in inventory[prefix]['py:class']: newtarget = inventory[prefix]['py:class'][reftarget][2] - if not node['refexplicit'] and \ - '~' not in node.rawsource: + if not refexplicit and '~' not in node.rawsource: contnode = literal(text=reftarget) newnode = reference('', '', internal=True) newnode['reftitle'] = reftarget @@ -87,11 +120,10 @@ if reftarget in mapping: newtarget = mapping[reftarget] + suffix - if not node['refexplicit'] and '~' not in node.rawsource: + if not refexplicit and '~' not in node.rawsource: contnode = literal(text=newtarget) - newnode = env.domains['py'].resolve_xref( - env, node['refdoc'], app.builder, 'class', newtarget, - node, contnode) + newnode = env.domains['py'].resolve_xref(env, refdoc, app.builder, 'class', + newtarget, node, contnode) if newnode is not None: newnode['reftitle'] = reftarget return newnode diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/input/index.rst sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/input/index.rst --- sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/input/index.rst 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/input/index.rst 2020-09-24 20:38:30.000000000 +0000 @@ -0,0 +1,2 @@ +.. automodapi:: sphinx_automodapi.tests.example_module + :allowed-package-names: sphinx_automodapi.tests.example_module.classes diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Egg.rst sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Egg.rst --- sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Egg.rst 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Egg.rst 2020-09-24 20:38:30.000000000 +0000 @@ -0,0 +1,29 @@ +Egg +=== + +.. currentmodule:: sphinx_automodapi.tests.example_module + +.. autoclass:: Egg + :show-inheritance: + + .. rubric:: Attributes Summary + + .. autosummary:: + + ~Egg.weight + + .. rubric:: Methods Summary + + .. autosummary:: + + ~Egg.buy + ~Egg.eat + + .. rubric:: Attributes Documentation + + .. autoattribute:: weight + + .. rubric:: Methods Documentation + + .. automethod:: buy + .. automethod:: eat diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Spam.rst sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Spam.rst --- sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Spam.rst 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Spam.rst 2020-09-24 20:38:30.000000000 +0000 @@ -0,0 +1,7 @@ +Spam +==== + +.. currentmodule:: sphinx_automodapi.tests.example_module + +.. autoclass:: Spam + :show-inheritance: diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodapi sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodapi --- sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodapi 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodapi 2020-09-24 20:38:30.000000000 +0000 @@ -0,0 +1,21 @@ + +sphinx_automodapi.tests.example_module Package +---------------------------------------------- + +.. automodule:: sphinx_automodapi.tests.example_module + +Classes +^^^^^^^ + +.. automodsumm:: sphinx_automodapi.tests.example_module + :classes-only: + :toctree: api + :allowed-package-names: sphinx_automodapi.tests.example_module.classes + +Class Inheritance Diagram +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automod-diagram:: sphinx_automodapi.tests.example_module + :private-bases: + :parts: 1 + :allowed-package-names: sphinx_automodapi.tests.example_module.classes diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodsumm sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodsumm --- sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodsumm 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodsumm 2020-09-24 20:38:30.000000000 +0000 @@ -0,0 +1,7 @@ +.. currentmodule:: sphinx_automodapi.tests.example_module + +.. autosummary:: + :toctree: api + + Egg + Spam diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/README.md sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/README.md --- sphinx-automodapi-0.12/sphinx_automodapi/tests/cases/allowed_names/README.md 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/cases/allowed_names/README.md 2020-09-24 20:38:30.000000000 +0000 @@ -0,0 +1,2 @@ +Documenting a module with classes, functions, and variables that are +imported from other files, but where only some of those are allowed. diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/example_module/noall.py sphinx-automodapi-0.13/sphinx_automodapi/tests/example_module/noall.py --- sphinx-automodapi-0.12/sphinx_automodapi/tests/example_module/noall.py 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/example_module/noall.py 2020-09-24 20:38:30.000000000 +0000 @@ -0,0 +1,23 @@ +""" +A collection of useful classes and functions +""" +from collections import OrderedDict + + +def add(a, b): + """ + Add two numbers + """ + return a + b + + +class MixedSpam(OrderedDict): + """ + Special spam + """ + + def eat(self, time): + """ + Eat special spam in the required time. + """ + pass diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/test_automodsumm.py sphinx-automodapi-0.13/sphinx_automodapi/tests/test_automodsumm.py --- sphinx-automodapi-0.12/sphinx_automodapi/tests/test_automodsumm.py 2019-08-15 10:12:55.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/test_automodsumm.py 2020-09-24 20:38:30.000000000 +0000 @@ -3,6 +3,7 @@ from copy import copy +import pytest from docutils.parsers.rst import directives, roles from . import cython_testpackage # noqa @@ -107,6 +108,54 @@ "classes-only, and variables-only. Skipping this directive." in stderr) +ORDEREDDICT_RST = """ +:orphan: + +OrderedDict +=========== + +.. currentmodule:: sphinx_automodapi.tests.example_module.noall + +.. autoclass:: OrderedDict + :show-inheritance: +""".strip() + + +@pytest.mark.parametrize('options,expect', [ + ('', ['add', 'MixedSpam']), + (':allowed-package-names: sphinx_automodapi', ['add', 'MixedSpam']), + (':allowed-package-names: collections', ['OrderedDict']), + (':allowed-package-names: sphinx_automodapi,collections', + ['add', 'MixedSpam', 'OrderedDict']), +]) +def test_am_allowed_package_names(options, expect, tmpdir): + """ + Test that allowed_package_names is interpreted correctly. + """ + def mixed2noall(s): + return s.replace('example_module.mixed', 'example_module.noall') + + am_str = ams_to_asmry_str + with open(tmpdir.join('index.rst').strpath, 'w') as f: + f.write(mixed2noall(am_str).format(options=(' '+options if options else ''))) + + apidir = tmpdir.mkdir('api') + with open(apidir.join('sphinx_automodapi.tests.example_module.noall.add.rst').strpath, 'w') as f: + f.write(mixed2noall(ADD_RST)) + with open(apidir.join('sphinx_automodapi.tests.example_module.noall.MixedSpam.rst').strpath, 'w') as f: + f.write(mixed2noall(MIXEDSPAM_RST)) + with open(apidir.join('sphinx_automodapi.tests.example_module.noall.OrderedDict.rst').strpath, 'w') as f: + f.write(ORDEREDDICT_RST) + + run_sphinx_in_tmpdir(tmpdir) + + with open(tmpdir.join('index.rst.automodsumm').strpath) as f: + result = f.read() + + for x in expect: + assert ' '+x in result + + PILOT_RST = """ :orphan: diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/test_cases.py sphinx-automodapi-0.13/sphinx_automodapi/tests/test_cases.py --- sphinx-automodapi-0.12/sphinx_automodapi/tests/test_cases.py 2019-08-15 10:12:55.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/test_cases.py 2020-09-24 20:38:30.000000000 +0000 @@ -74,7 +74,8 @@ 'automodsumm_writereprocessed': True}) if os.path.basename(case_dir) in ('mixed_toplevel', - 'mixed_toplevel_all_objects'): + 'mixed_toplevel_all_objects', + 'allowed_names'): conf['extensions'].append('sphinx_automodapi.smart_resolver') start_dir = os.path.abspath('.') diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/tests/test_utils.py sphinx-automodapi-0.13/sphinx_automodapi/tests/test_utils.py --- sphinx-automodapi-0.12/sphinx_automodapi/tests/test_utils.py 2018-01-29 15:18:51.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/tests/test_utils.py 2020-09-24 20:38:30.000000000 +0000 @@ -22,3 +22,24 @@ assert 'namedtuple' not in lnms assert 'collections.namedtuple' not in fqns assert namedtuple not in objs + + +def test_find_mod_objs_with_list_of_modules(): + lnms, fqns, objs = find_mod_objs( + 'sphinx_automodapi.tests.test_utils', onlylocals=['sphinx_automodapi']) + + assert namedtuple not in objs + assert find_mod_objs in objs + + lnms, fqns, objs = find_mod_objs( + 'sphinx_automodapi.tests.test_utils', onlylocals=['collections']) + + assert namedtuple in objs + assert find_mod_objs not in objs + + lnms, fqns, objs = find_mod_objs( + 'sphinx_automodapi.tests.test_utils', onlylocals=['collections', + 'sphinx_automodapi']) + + assert namedtuple in objs + assert find_mod_objs in objs diff -Nru sphinx-automodapi-0.12/sphinx_automodapi/utils.py sphinx-automodapi-0.13/sphinx_automodapi/utils.py --- sphinx-automodapi-0.12/sphinx_automodapi/utils.py 2019-08-15 10:12:55.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi/utils.py 2020-09-24 20:38:30.000000000 +0000 @@ -3,9 +3,7 @@ import re import os from warnings import warn -from distutils.version import LooseVersion -from sphinx import __version__ from sphinx.ext.autosummary.generate import find_autosummary_in_docstring __all__ = ['cleanup_whitespace', @@ -58,9 +56,10 @@ ---------- modname : str The name of the module to search. - onlylocals : bool + onlylocals : bool or list If True, only attributes that are either members of `modname` OR one of - its modules or subpackages will be included. + its modules or subpackages will be included. If a list, only members + of packages in the list are included. If `False`, selection is done. Returns ------- @@ -82,10 +81,12 @@ __import__(modname) mod = sys.modules[modname] + # Note: use getattr instead of mod.__dict__[k] for modules that + # define their own __getattr__ and __dir__. if hasattr(mod, '__all__'): - pkgitems = [(k, mod.__dict__[k]) for k in mod.__all__] + pkgitems = [(k, getattr(mod, k)) for k in mod.__all__] else: - pkgitems = [(k, mod.__dict__[k]) for k in dir(mod) if k[0] != '_'] + pkgitems = [(k, getattr(mod, k)) for k in dir(mod) if k[0] != '_'] # filter out modules and pull the names and objs out ismodule = inspect.ismodule @@ -101,6 +102,8 @@ fqnames.append(modname + '.' + lnm) if onlylocals: + if isinstance(onlylocals, (tuple, list)): + modname = tuple(onlylocals) valids = [fqn.startswith(modname) for fqn in fqnames] localnames = [e for i, e in enumerate(localnames) if valids[i]] fqnames = [e for i, e in enumerate(fqnames) if valids[i]] diff -Nru sphinx-automodapi-0.12/sphinx_automodapi.egg-info/PKG-INFO sphinx-automodapi-0.13/sphinx_automodapi.egg-info/PKG-INFO --- sphinx-automodapi-0.12/sphinx_automodapi.egg-info/PKG-INFO 2019-08-15 10:17:24.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi.egg-info/PKG-INFO 2020-09-24 20:43:07.000000000 +0000 @@ -1,6 +1,6 @@ Metadata-Version: 2.1 Name: sphinx-automodapi -Version: 0.12 +Version: 0.13 Summary: Sphinx extension for auto-generating API documentation for entire modules Home-page: http://astropy.org Author: The Astropy Developers @@ -43,4 +43,5 @@ Classifier: Programming Language :: Python :: 3 Classifier: Operating System :: OS Independent Classifier: License :: OSI Approved :: BSD License +Requires-Python: >=3.6 Provides-Extra: test diff -Nru sphinx-automodapi-0.12/sphinx_automodapi.egg-info/requires.txt sphinx-automodapi-0.13/sphinx_automodapi.egg-info/requires.txt --- sphinx-automodapi-0.12/sphinx_automodapi.egg-info/requires.txt 2019-08-15 10:17:24.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi.egg-info/requires.txt 2020-09-24 20:43:07.000000000 +0000 @@ -5,4 +5,4 @@ pytest-cov cython codecov -coverage +coverage<5.0 diff -Nru sphinx-automodapi-0.12/sphinx_automodapi.egg-info/SOURCES.txt sphinx-automodapi-0.13/sphinx_automodapi.egg-info/SOURCES.txt --- sphinx-automodapi-0.12/sphinx_automodapi.egg-info/SOURCES.txt 2019-08-15 10:17:24.000000000 +0000 +++ sphinx-automodapi-0.13/sphinx_automodapi.egg-info/SOURCES.txt 2020-09-24 20:43:07.000000000 +0000 @@ -1,19 +1,9 @@ -.coveragerc -.gitignore CHANGES.rst LICENSE.rst MANIFEST.in README.rst -azure-pipelines.yml -azure-template.yml setup.cfg setup.py -tox.ini -docs/Makefile -docs/automodapi.rst -docs/automodsumm.rst -docs/conf.py -docs/index.rst sphinx_automodapi/__init__.py sphinx_automodapi/autodoc_enhancements.py sphinx_automodapi/automodapi.py @@ -41,6 +31,12 @@ sphinx_automodapi/tests/cases/abstract_classes/output/index.rst.automodapi sphinx_automodapi/tests/cases/abstract_classes/output/index.rst.automodsumm sphinx_automodapi/tests/cases/abstract_classes/output/api/sphinx_automodapi.tests.example_module.abstract_classes.SequenceSubclass.rst +sphinx_automodapi/tests/cases/allowed_names/README.md +sphinx_automodapi/tests/cases/allowed_names/input/index.rst +sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodapi +sphinx_automodapi/tests/cases/allowed_names/output/index.rst.automodsumm +sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Egg.rst +sphinx_automodapi/tests/cases/allowed_names/output/api/sphinx_automodapi.tests.example_module.Spam.rst sphinx_automodapi/tests/cases/classes_no_inherit/README.md sphinx_automodapi/tests/cases/classes_no_inherit/input/index.rst sphinx_automodapi/tests/cases/classes_no_inherit/output/index.rst.automodapi @@ -141,5 +137,6 @@ sphinx_automodapi/tests/example_module/functions.py sphinx_automodapi/tests/example_module/functions_with_ref.py sphinx_automodapi/tests/example_module/mixed.py +sphinx_automodapi/tests/example_module/noall.py sphinx_automodapi/tests/example_module/other_classes.py sphinx_automodapi/tests/example_module/variables.py \ No newline at end of file diff -Nru sphinx-automodapi-0.12/tox.ini sphinx-automodapi-0.13/tox.ini --- sphinx-automodapi-0.12/tox.ini 2019-08-15 10:12:55.000000000 +0000 +++ sphinx-automodapi-0.13/tox.ini 1970-01-01 00:00:00.000000000 +0000 @@ -1,32 +0,0 @@ -[tox] -envlist = - py27-test - py37-test - py27-test-clocale - py37-test-clocale - py27-test-sphinx17 - py36-test-sphinx17 - py37-test-sphinx18 - py37-test-sphinx20 - py37-test-sphinxdev -requires = pip >= 18.0 - setuptools >= 30.3.0 - -[testenv] -changedir = .tmp/{envname} -deps = - sphinx17: sphinx==1.7.9 - sphinx18: sphinx==1.8.5 - sphinx20: sphinx==2.0.1 - sphinx21: sphinx==2.1.2 - sphinxdev: git+https://github.com/sphinx-doc/sphinx.git -extras = - test: test -commands = - test: pytest --pyargs sphinx_automodapi --cov-append --cov sphinx_automodapi --cov-report= -setenv = - clocale: LC_CTYPE=C - clocale: LC_ALL=C - clocale: LANG=C -platform = - clocale: linux|darwin