Documentation of modules with sphinx

C2SM / iconarray

R&D Python package for processing ICON data with xarray

https://c2sm.github.io/iconarray/

BSD 3-Clause "New" or "Revised" License

10 stars 2 forks source link

Closed victoria-cherkas closed 2 years ago

victoria-cherkas commented 2 years ago

Create documentation of modules with sphinx

victoria-cherkas commented 2 years ago

Flake configuration: remove exception for D1 # Public code object needs docstring

And then document and link with sphinx

victoria-cherkas commented 2 years ago

Update - would like to remove below exceptions (and passes all tests) from flake8 config before marking this as complete.

D102    # Missing docstring in public method
DAR401  # Missing exception(s) in Raises section: -r Exception