Skip to content

ReadTheDocs - which methods too include and formatting issues #69

@kysolvik

Description

@kysolvik

ReadTheDocs site is up: https://dataassimbench.readthedocs.io/en/latest/index.html

But two major problems:

  1. Used Sphinx AutoAPI to generate API Reference, but included internal methods (_*). Needed this to capture public methods in non-public modules. Should either make those modules public or tweak the AutoAPI config.
  2. Some docstring formatting issues. Missing newline in attribute descriptions, e.g.: https://dataassimbench.readthedocs.io/en/latest/autoapi/dabench/data/gcp/index.html

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions