You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- PyTest can be installed with `pip3 install --editable .[dev]`
62
+
- PyTest is listed as a development dependency, and can thus be installed with `pip3 install --editable .[dev]`
62
63
- Tests can be run with `pytest`
63
64
- This is configured in `setup.cfg`
64
-
-Use[GitHub action workflow](https://docs.github.com/en/actions) to automatically run tests on GitHub infrastructure against multiple Python versions
65
-
-Workflow can be found in [`.github/workflows/build.yml`](.github/workflows/build.yml)
65
+
-Uses[GitHub action workflows](https://docs.github.com/en/actions) to automatically run tests on GitHub infrastructure against multiple Python versions
66
+
-Workflows can be found in [`.github/workflows`](.github/workflows/)
66
67
-[Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=testing)
67
68
68
69
## Documentation
69
70
70
-
- Documentation should be put in the `docs` folder. The contents have been generated using `sphinx-quickstart` (Sphinx version 1.6.5).
71
+
- Documentation should be put in the `docs/` directory. The contents have been generated using `sphinx-quickstart` (Sphinx version 1.6.5).
71
72
- We recommend writing the documentation using Restructured Text (reST) and Google style docstrings.
72
73
-[Restructured Text (reST) and Sphinx CheatSheet](http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html)
- The documentation is set up with the Read the Docs Sphinx Theme.
75
-
- Check out the [configuration options](https://sphinx-rtd-theme.readthedocs.io/en/latest/).
76
-
- To generate html documentation run `python setup.py build_sphinx`
77
-
- This is configured in `setup.cfg`
78
-
- Alternatively, run `make html` in the `docs` folder.
79
-
- The `docs/_templates` directory contains an (empty) `.gitignore` file, to be able to add it to the repository. This
80
-
file can be safely removed (or you can just leave it there).
75
+
- The documentation is set up with the ReadTheDocs Sphinx theme.
76
+
- Check out its [configuration options](https://sphinx-rtd-theme.readthedocs.io/en/latest/).
77
+
- To generate HTML documentation, run `make html` in the `docs/` folder.
81
78
- To put the documentation on [ReadTheDocs](https://readthedocs.org), log in to your ReadTheDocs account, and import
82
79
the repository (under 'My Projects').
83
80
- Include the link to the documentation in your project's [README.md](README.md).
@@ -93,11 +90,11 @@ help you decide which tool to use for packaging.
93
90
## Continuous code quality
94
91
95
92
-[Sonarcloud](https://sonarcloud.io/) is used to perform quality analysis and code coverage report on each push
96
-
-The GitHub organization and repository must be added Sonarcloud for analysis to work
93
+
-Sonarcloud must be configured for the analysis to work
97
94
1. go to [Sonarcloud](https://sonarcloud.io/projects/create)
98
95
2. login with your GitHub account
99
96
3. add organization or reuse existing
100
-
4.setup repository
97
+
4.set up repository
101
98
5. go to [new code definition administration page](https://sonarcloud.io/project/new_code?id={{ cookiecutter.github_organization }}_{{ cookiecutter.project_name }}) and select `Number of days` option
102
99
- The analysis will be run by [GitHub Action workflow](.github/workflows/quality.yml)
103
100
- To be able to run the analysis, a token must be created at [Sonarcloud account](https://sonarcloud.io/account/security/) and this token must be added as `SONAR_TOKEN` to [secrets on GitHub](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_name }}/settings/secrets/actions)
@@ -134,7 +131,7 @@ save it as a secret called `PYPI_TOKEN` on [Settings page]({{cookiecutter.reposi
134
131
- It only makes sense to do this once there is something to cite (e.g., a software release with a DOI).
135
132
- Follow the [making software citable](https://guide.esciencecenter.nl/#/citable_software/making_software_citable) section in the guide.
136
133
137
-
## CODE\_OF\_CONDUCT.md
134
+
## CODE_OF_CONDUCT.md
138
135
139
136
- Information about how to behave professionally
140
137
-[Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=code-of-conduct)
0 commit comments