DM 30015: Update conf.py for documenteer 0.6 #112
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
|
@jonathansick do you want me to review some of these? They don't all have to be reviewed and merged on the same day. Incrementally works fine. |
|
If you'd like to review (and even merge) that'd be great. Thanks. |
Update conf.py for the new documenteer 0.6 configuration API. Based on the latest updates in the package template (https://github.com/lsst/templates/tree/master/project_templates/stack_package)
timj
force-pushed
the
tickets/DM-30015
branch
from
3c3d31a
to
6c0d8a1
Compare
timj
reviewed
Dec 7, 2021
| """ | ||
|
|
||
| from documenteer.sphinxconfig.stackconf import build_package_configs | ||
| import lsst.ap.association | ||
| from documenteer.conf.pipelinespkg import * |
There was a problem hiding this comment.
As a general comment (too late now given it's everywhere) it would seem less like magic and more PEP8 as:
import documenteer.conf.pipelinespkg as p
p.project = "ap_association"There was a problem hiding this comment.
Did you check this with a Sphinx run? I'm not sure this would be compatible with the namespacing that Sphinx expects for configurations.
There was a problem hiding this comment.
Aha. I'll take a look. I'm sure you are right -- namespace shenanigans seems right.
There was a problem hiding this comment.
Right. Falls over completely. I'll merge this.
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.
Update conf.py for the new documenteer 0.6 configuration API. Based on
the latest updates in the package template
(https://github.com/lsst/templates/tree/master/project_templates/stack_package)