Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Story Points:2.6
-
Epic Link:
-
Team:SQuaRE
Description
The sphinx_automodapi extension is now available as a standalone package at http://sphinx-automodapi.readthedocs.io/en/latest/ / https://github.com/astropy/sphinx-automodapi
Formerly it was part of astropy-helpers. Switching to this standalone version is good for us since it will reduce the overall weight of documenteer's dependencies.
This is targeted for the 0.3 release of documenteer.
Attachments
Issue Links
- has to be done after
-
DM-14777 Create remote-code-block Sphinx directive
- Done
Activity
I'm finding that I cannot use autodoc_default_flags = ['inherited-members'] to include inherited members in class documentation. The reason is that in the https://github.com/lsst/verify there are a few instances of automodapi that point directly to individual modules like lsst.verify.bin.dispatchverify. For at least some of these, enabling inherited-members means that the full API reference is being included in the index.rst's page at the automodapi invocation, in addition to the page generated by automodapi.
Here's the log output showing these errors from duplicate documentation:
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/bin/dispatchverify.py:docstring of lsst.verify.bin.dispatchverify.Configuration:1: WARNING: duplicate object description of lsst.verify.bin.dispatchverify.Configuration, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/bin/dispatchverify.py:docstring of lsst.verify.bin.dispatchverify.insert_env_metadata:1: WARNING: duplicate object description of lsst.verify.bin.dispatchverify.insert_env_metadata, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/bin/dispatchverify.py:docstring of lsst.verify.bin.dispatchverify.insert_extra_package_metadata:1: WARNING: duplicate object description of lsst.verify.bin.dispatchverify.insert_extra_package_metadata, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/bin/dispatchverify.py:docstring of lsst.verify.bin.dispatchverify.insert_lsstsw_metadata:1: WARNING: duplicate object description of lsst.verify.bin.dispatchverify.insert_lsstsw_metadata, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/bin/dispatchverify.py:docstring of lsst.verify.bin.dispatchverify.main:1: WARNING: duplicate object description of lsst.verify.bin.dispatchverify.main, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/jsonmixin.py:docstring of lsst.verify.jsonmixin.JsonSerializationMixin:1: WARNING: duplicate object description of lsst.verify.jsonmixin.JsonSerializationMixin, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/jsonmixin.py:docstring of lsst.verify.jsonmixin.JsonSerializationMixin.json:1: WARNING: duplicate object description of lsst.verify.jsonmixin.JsonSerializationMixin.json, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/jsonmixin.py:docstring of lsst.verify.jsonmixin.JsonSerializationMixin.jsonify_dict:1: WARNING: duplicate object description of lsst.verify.jsonmixin.JsonSerializationMixin.jsonify_dict, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/jsonmixin.py:docstring of lsst.verify.jsonmixin.JsonSerializationMixin.write_json:1: WARNING: duplicate object description of lsst.verify.jsonmixin.JsonSerializationMixin.write_json, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/eupsmanifest.py:docstring of lsst.verify.metadata.eupsmanifest.Manifest:1: WARNING: duplicate object description of lsst.verify.metadata.eupsmanifest.Manifest, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/eupsmanifest.py:docstring of lsst.verify.metadata.eupsmanifest.Manifest.build:1: WARNING: duplicate object description of lsst.verify.metadata.eupsmanifest.Manifest.build, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/eupsmanifest.py:docstring of lsst.verify.metadata.eupsmanifest.Manifest.items:1: WARNING: duplicate object description of lsst.verify.metadata.eupsmanifest.Manifest.items, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/jenkinsci.py:docstring of lsst.verify.metadata.jenkinsci.get_jenkins_env:1: WARNING: duplicate object description of lsst.verify.metadata.jenkinsci.get_jenkins_env, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/lsstsw.py:docstring of lsst.verify.metadata.lsstsw.LsstswRepos:1: WARNING: duplicate object description of lsst.verify.metadata.lsstsw.LsstswRepos, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/lsstsw.py:docstring of lsst.verify.metadata.lsstsw.LsstswRepos.manifest_path:1: WARNING: duplicate object description of lsst.verify.metadata.lsstsw.LsstswRepos.manifest_path, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/lsstsw.py:docstring of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_branch:1: WARNING: duplicate object description of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_branch, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/lsstsw.py:docstring of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_commit_sha:1: WARNING: duplicate object description of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_commit_sha, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/lsstsw.py:docstring of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_repo_path:1: WARNING: duplicate object description of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_repo_path, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/metadata/lsstsw.py:docstring of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_repo_url:1: WARNING: duplicate object description of lsst.verify.metadata.lsstsw.LsstswRepos.get_package_repo_url, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/report.py:docstring of lsst.verify.report.Report:1: WARNING: duplicate object description of lsst.verify.report.Report, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/report.py:docstring of lsst.verify.report.Report.make_table:1: WARNING: duplicate object description of lsst.verify.report.Report.make_table, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/report.py:docstring of lsst.verify.report.Report.show:1: WARNING: duplicate object description of lsst.verify.report.Report.show, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/squash.py:docstring of lsst.verify.squash.get:1: WARNING: duplicate object description of lsst.verify.squash.get, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/squash.py:docstring of lsst.verify.squash.get_default_api_version:1: WARNING: duplicate object description of lsst.verify.squash.get_default_api_version, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/squash.py:docstring of lsst.verify.squash.get_default_timeout:1: WARNING: duplicate object description of lsst.verify.squash.get_default_timeout, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/squash.py:docstring of lsst.verify.squash.get_endpoint_url:1: WARNING: duplicate object description of lsst.verify.squash.get_endpoint_url, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/squash.py:docstring of lsst.verify.squash.make_accept_header:1: WARNING: duplicate object description of lsst.verify.squash.make_accept_header, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/squash.py:docstring of lsst.verify.squash.post:1: WARNING: duplicate object description of lsst.verify.squash.post, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
/Users/jsick/lsst/pipelines_lsst_io_stack/verify/python/lsst/verify/squash.py:docstring of lsst.verify.squash.reset_endpoint_cache:1: WARNING: duplicate object description of lsst.verify.squash.reset_endpoint_cache, other instance in /Users/jsick/lsst/pipelines_lsst_io_stack/verify/doc/lsst.verify/index.rst, use :noindex: for one of them
|
Possibly also address https://github.com/lsst-sqre/documenteer/issues/27 to include special (dunder) methods in the automodapi output.