hydrologie / xhydro / 14139574791

92%

Build Type

push

github

Committed by web-flow

Commit Message

Improvements to the base documentation (#274)

<!-- Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
  - This PR fixes #xyz
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] (If applicable) Tests have been added.
- [x] CHANGELOG.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

### What kind of change does this PR introduce?

* Updated the install instruction, which were quite outdated.
* Added a "Documentation and Support" section to the `docs/index.rst`
file, providing quick access to the GitHub repository, PyPI package, and
Conda package.
* Attempted to see if you still need ESMPy instructions in the Makefile.
We'll see...
This pull request includes various updates to documentation and
configuration files aimed at improving clarity, updating dependencies,
and ensuring consistent naming conventions. The most important changes
are summarized below:

### Does this PR introduce a breaking change?


### Other information:

* This automatically staged the deletion of `_simple_models` which was
meant for another PR. This will break the docs and tests, but oh well.
We just have to merge this after.

Run Details

18 of 18 new or added lines in 7 files covered. (100.0%)

15 existing lines in 2 files now uncovered.

2373 of 2557 relevant lines covered (92.8%)

3.35 hits per line