Skip to content

More xarray, docs, and tests #29

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.

Sign up for GitHub

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

Closed
malmans2 wants to merge 2 commits into from
Closed

More xarray, docs, and tests #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cef608c
more xr, docs, and tests
malmans2 Jun 14, 2021
509bab6
Merge branch 'main' into more_xr
malmans2 Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ repos:
hooks:
- id: mypy
exclude: docs
additional_dependencies: [xarray]

- repo: https://github.com/PyCQA/doc8
rev: 0.9.0a1
Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@
# Darglint is already forcing us to have consistent types in the docstring.
autodoc_typehints = "none"

# Do not warn about missing "Methods" in class docstring
numpydoc_show_class_members = False

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
2 changes: 2 additions & 0 deletions docs/developers/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Unreleased

- Added :py:func:`~pydomcfg.bathymetry.sea_mount`
useful to generate classic sea mount test case. (:pr:`17`)
- Added :py:class:`~pydomcfg.domzgr.zco.Zco`
to generate geopotential z-coordinates. (:pr:`15`)
- Added :py:func:`~pydomcfg.utils.generate_cartesian_grid`
useful to generate test datasets. (:pr:`8`)
- pyDOMCFG is on GitHub! (:pr:`1`)
11 changes: 11 additions & 0 deletions docs/users/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ API reference

This page provides an auto-generated summary of pyDOMCFG's API.

Domzgr
======

Zco
----
.. autoclass:: pydomcfg.domzgr.zco.Zco
:members:

.. automethod:: __init__
.. automethod:: __call__

Utils
=====
.. autosummary::
Expand Down
Loading