Skip to content

Commit 81662cf

Browse files
committed
Write up Read the Docs instructions
Refs #237
1 parent 949ebd3 commit 81662cf

3 files changed

Lines changed: 18 additions & 7 deletions

File tree

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
---
2-
title: 'Next step: readthedocs'
2+
title: 'Next step: Read the Docs'
33
labels:
44
- 'action required'
55
---
66

7-
Readthedocs instructions.
7+
Your Python package should have publicly readable documentation, including API documentation, for your users.
8+
[Read the Docs](https://readthedocs.org) can host your user documentation for you.
9+
10+
To host the documentation of this repository please perform the following instructions:
11+
12+
1. go to [Read the Docs](https://readthedocs.org/dashboard/import/?)
13+
1. log in with your GitHub account
14+
1. find `{{ cookiecutter.github_organization }}/{{ cookiecutter.project_name }}` in list and press `+` button.
15+
* If repository is not listed,
16+
1. go to [Read the Docs GitHub app](https://github.com/settings/connections/applications/fae83c942bc1d89609e2)
17+
2. make sure {{ cookiecutter.github_organization }} has been granted access.
18+
3. Reload repository list on Read the Docs import page
19+
1. wait for the first build to be completed at <https://readthedocs.org/projects/{{ cookiecutter.project_name }}/builds>
20+
1. check that the link of the documentation badge in the [README.md]({{ cookiecutter.repository }}) works
21+
22+
See [README.dev.md#]({{cookiecutter.repository}}/blob/main/README.dev.md#generating-the-api-docs) how to build documentation site locally.

{{cookiecutter.project_name}}/.github/workflows/next_steps.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
echo 'Created issues that must be completed to have fully working Python package:
5252
* Sonarcloud integration ${{ steps.sonarcloud.outputs.url }}
5353
* Zenodo integration ${{ steps.zenodo.outputs.url }}
54-
* Readthedocs instructions ${{ steps.readthedocs.outputs.url }}
54+
* Read the Docs instructions ${{ steps.readthedocs.outputs.url }}
5555
* Citation data ${{ steps.citation.outputs.url }}
5656
* Linting fixes ${{ steps.linting.outputs.url }}'
5757
- name: Cleanup files needed to create next steps issues

{{cookiecutter.project_name}}/project_setup.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,6 @@ help you decide which tool to use for packaging.
8181
- [Google style docstring examples](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
8282
- The documentation is set up with the ReadTheDocs Sphinx theme.
8383
- Check out its [configuration options](https://sphinx-rtd-theme.readthedocs.io/en/latest/).
84-
- To generate HTML documentation, run `make html` in the `docs/` folder.
85-
- To put the documentation on [ReadTheDocs](https://readthedocs.org), log in to your ReadTheDocs account, and import
86-
the repository (under 'My Projects').
87-
- Include the link to the documentation in your project's [README.md](README.md).
8884
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=writingdocumentation)
8985

9086
## Coding style conventions and code quality

0 commit comments

Comments
 (0)