Skip to content

Conversation

@kysolvik
Copy link
Collaborator

Fixes for #69

  • Added Napoleon extension to support Google-style docstrings. Fixed most formatting, but need to go through to make sure everything is consistent and rendering correctly. Currently, there's a split between parameters and the docstrings for them. It might be cleaner if everything is shown together. Probably just an option I'm missing.
  • Added automatic type-hint support via autodoc.
  • Made dabench/data/* submodules non-public (_*) to match the rest of the package and to avoid confusing extra documentation of submodules that are only there for organization and aren't supposed to be imported directly.

Preview the new docs here: https://dataassimbench.readthedocs.io/en/docs-rtd-autoapi-fixes/autoapi/dabench/index.html

Will change to non-draft once I've checked through everything for consistency and looked into the parameter/docstring split problem mentioned above.

@kysolvik
Copy link
Collaborator Author

Found the fix for the parameter/docstring issue. Need to make sure we're distinguishing between attributes and args for classes. My fault for not being careful about that.

Good news is that this will fix a problem that I might not have found without this issue!

Bad news is I need to go through all classes and apply the fix.

Will update as soon as that's done.

kysolvik added 20 commits April 18, 2025 14:36
…ould improve documentation for class attributes or just make them non-public since user shouldn't need them
…se since we now produce xarray objects which have that information (used to save values in the data generator object instead)
…sh between constructor args and attributes assigned based on those args (and 'locations' and 'times' which can be both)
@kysolvik kysolvik marked this pull request as ready for review April 24, 2025 00:22
@kysolvik
Copy link
Collaborator Author

@StevePny This is ready for review.

Solves #69.

You can preview the API reference docs here: https://dataassimbench.readthedocs.io/en/docs-rtd-autoapi-fixes/autoapi/dabench/index.html

I focused on docs updates so as not to change functionality in this PR, but there's some outstanding items with open issues #51 and #71

@kysolvik kysolvik merged commit 4070e99 into main Apr 25, 2025
1 check passed
@kysolvik kysolvik deleted the docs/rtd-autoapi-fixes branch April 25, 2025 20:41
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.

3 participants