DM-20659: Fixes for the lsst.afw.table doc build #477
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kfindeisen
reviewed
Jul 19, 2019
doc/lsst.afw.table/index.rst
Outdated
| .. automodapi:: lsst.afw.table.baseColumnView | ||
| .. automodapi:: lsst.afw.table.schema | ||
| :no-main-docstr: | ||
|
|
||
| .. automodapi:: lsst.afw.table.schemaMapper |
There was a problem hiding this comment.
Oops, it didn't occur to me that #476 might affect the docs. lsst.afw.table.schemaMapper no longer exists; afw.table is one monolithic package now (.io is still a subpackage, and .testUtils is still a submodule, though).
There was a problem hiding this comment.
@kfindeisen Thanks for the tip on that
czwa
approved these changes
Jul 19, 2019
jonathansick
force-pushed
the
tickets/DM-20659
branch
from
f7c3b38
to
4ba3e7f
Compare
Since lsst.afw.table's __init__.py file already imports objects from subpackages into the lsst.afw.table namespace, there shouldn't be extra automodapi directives for those subpackages. Only io, schemaMapper and testUtils seem to be subpackages that aren't imported into lsst.afw.table itself. Also sets the standard no-main-docstr flag.
This file not exist.
jonathansick
force-pushed
the
tickets/DM-20659
branch
from
4ba3e7f
to
5d4e75c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR solves a documentation build error on Jenkins:
The basic issue was that there were automodapi statements for individual sub packages that were already being pulled in by the automodapi directive for
lsst.afw.tableitself. Deleting those redundant automodapi directives solved the build issue.