Skip to content

Commit fb7cd37

Browse files
committed
Adds some near final touch
1 parent f4d851d commit fb7cd37

File tree

4 files changed

+10
-6
lines changed

4 files changed

+10
-6
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please contact the [lead developers](https://climada.ethz.ch/team/) if you want
1616

1717
## Why Should You Contribute?
1818

19-
* You will be listed as author of the CLIMADA repository in the [AUTHORS](#authors) file.
19+
* You will be listed as author of the CLIMADA repository in the [AUTHORS](authors) file.
2020
* You will improve the quality of the CLIMADA software for you and for everybody else using it.
2121
* You will gain insights into scientific software development.
2222

@@ -40,7 +40,7 @@ To contribute follow these steps:
4040
```bash
4141
pylint
4242
```
43-
6. Add your name to the [AUTHORS](AUTHORS.md) file.
43+
6. Add your name to the [AUTHORS](authors) file.
4444
7. Push your updates to the remote repository:
4545
4646
```bash
@@ -84,3 +84,4 @@ It also contains a checklist for both pull request authors and reviewers to guid
8484
[docs]: https://climada-python.readthedocs.io/en/latest/
8585
[devguide]: https://climada-python.readthedocs.io/en/latest/#developer-guide
8686
[testing]: https://climada-python.readthedocs.io/en/latest/development/Guide_Testing.html
87+
[authors]: https://github.com/CLIMADA-project/climada_python/blob/main/AUTHORS.md

doc/api/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
API Reference
33
==============
44

5-
Could be nice to have an API section homepage
5+
The API reference contains the whole specification of the code, that is, every modules,
6+
classes (and their attributes), and functions that are available (and documented).
67

78
.. toctree::
89
:caption: API Reference

doc/development/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
.. include:: ../misc/CONTRIBUTING.md
1+
.. include:: ../../CONTRIBUTING.md
22
:parser: myst_parser.sphinx_
33

44
.. toctree::
55
:maxdepth: 2
66
:hidden:
77

8-
Developer guide <Guide_CLIMADA_Development>
9-
Development with Git <dev-git>
8+
Overview <Guide_CLIMADA_Development>
9+
Developing with Git <dev-git>
1010
Coding in python <coding-in-python>
1111
CLIMADA Coding Conventions <Guide_CLIMADA_conventions>
1212
CLIMADA Configuration convention <Guide_Configuration>

doc/misc/AUTHORS.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. include:: ../../AUTHORS.md
2+
:parser: myst_parser.sphinx_

0 commit comments

Comments
 (0)