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.

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

Update docs #17

Merged
merged 2 commits into from
Dec 14, 2023
Merged

Update docs #17

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
e70d333
Update install docs
sandorkertesz Dec 14, 2023
1b7d3dd
Upgrade language-formatters-pre-commit-hooks
sandorkertesz Dec 14, 2023
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
5 changes: 2 additions & 3 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ repos:
hooks:
- id: isort
- repo: https://github.com/psf/black
rev: 23.3.0
rev: 23.9.1
hooks:
- id: black
- repo: https://github.com/keewis/blackdoc
Expand All @@ -33,13 +33,12 @@ repos:
- id: mdformat
exclude: cruft-update-template.md
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.4.0
rev: v2.11.0
hooks:
- id: pretty-format-yaml
args: [--autofix, --preserve-quotes]
- id: pretty-format-toml
args: [--autofix]
additional_dependencies: [toml-sort<0.22.0]
- repo: https://github.com/PyCQA/pydocstyle.git
rev: 6.1.1
hooks:
Expand Down
8 changes: 4 additions & 4 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Install **earthkit** with python3 (>= 3.8) and ``pip`` as follows:

python3 -m pip install earthkit

Alternatively, install via ``conda`` with:
.. Alternatively, install via ``conda`` with:

.. code-block:: bash
.. .. code-block:: bash

conda install earthkit -c conda-forge
.. conda install earthkit -c conda-forge

This will bring in some necessary binary dependencies for you.
.. This will bring in some necessary binary dependencies for you.

Installing the binary dependencies
--------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ branch = true
profile = "black"

[tool.pydocstyle]
convention = "numpy"
add_ignore = ["D1", "D200", "D205", "D400", "D401"]
convention = "numpy"

[tool.setuptools_scm]
write_to = "earthkit/version.py"
Expand Down
Loading