Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-30015: Update Sphinx conf.py for documenteer 0.6 #183

Merged
merged 2 commits into from Dec 8, 2021
Merged

Conversation

jonathansick
Copy link
Member

Updates based on the latest updates in the package template (https://github.com/lsst/templates/tree/master/project_templates/stack_package)

  • Add a basic README
  • Update doc/conf.py for the documenteer 0.6 Sphinx configuration API

@timj
Copy link
Member

timj commented Dec 7, 2021

@czwa since this pull request wanted to tidy up the flake8 exceptions I decided I should fix the W505 problems rather than keep putting them off. I don't like exceptions for things which are very easy to fix. Please take a look. I didn't try to fix the vestigial doxygen docstrings. There was one fix that was real and I don't understand why it didn't trigger a problem before.

@@ -339,7 +340,7 @@ def determineCalibClass(cls, metadata, message):
calibClassName = metadata.get("CALIBCLS")
calibClass = doImport(calibClassName) if calibClassName is not None else cls
if calibClass is IsrCalib:
raise ValueError(f"Cannot use base class to read calibration data: {msg}")
raise ValueError(f"Cannot use base class to read calibration data: {message}")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused by this one -- surely it should have been complaining before now.

@timj
Copy link
Member

timj commented Dec 7, 2021

Okay. I see that I should have done this on DM-31592. I'll make a new PR for that.

@timj
Copy link
Member

timj commented Dec 7, 2021

See #205

@timj timj merged commit 9cb7513 into main Dec 8, 2021
@timj timj deleted the tickets/DM-30015 branch December 8, 2021 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants