Skip to content

Commit

Permalink
Write up Read the Docs instructions
Browse files Browse the repository at this point in the history
Refs #237
  • Loading branch information
sverhoeven committed Apr 29, 2021
1 parent 949ebd3 commit 81662cf
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
19 changes: 17 additions & 2 deletions {{cookiecutter.project_name}}/.github/next_steps/03_readthedocs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
---
title: 'Next step: readthedocs'
title: 'Next step: Read the Docs'
labels:
- 'action required'
---

Readthedocs instructions.
Your Python package should have publicly readable documentation, including API documentation, for your users.
[Read the Docs](https://readthedocs.org) can host your user documentation for you.

To host the documentation of this repository please perform the following instructions:

1. go to [Read the Docs](https://readthedocs.org/dashboard/import/?)
1. log in with your GitHub account
1. find `{{ cookiecutter.github_organization }}/{{ cookiecutter.project_name }}` in list and press `+` button.
* If repository is not listed,
1. go to [Read the Docs GitHub app](https://github.com/settings/connections/applications/fae83c942bc1d89609e2)
2. make sure {{ cookiecutter.github_organization }} has been granted access.
3. Reload repository list on Read the Docs import page
1. wait for the first build to be completed at <https://readthedocs.org/projects/{{ cookiecutter.project_name }}/builds>
1. check that the link of the documentation badge in the [README.md]({{ cookiecutter.repository }}) works

See [README.dev.md#]({{cookiecutter.repository}}/blob/main/README.dev.md#generating-the-api-docs) how to build documentation site locally.
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
echo 'Created issues that must be completed to have fully working Python package:
* Sonarcloud integration ${{ steps.sonarcloud.outputs.url }}
* Zenodo integration ${{ steps.zenodo.outputs.url }}
* Readthedocs instructions ${{ steps.readthedocs.outputs.url }}
* Read the Docs instructions ${{ steps.readthedocs.outputs.url }}
* Citation data ${{ steps.citation.outputs.url }}
* Linting fixes ${{ steps.linting.outputs.url }}'
- name: Cleanup files needed to create next steps issues
Expand Down
4 changes: 0 additions & 4 deletions {{cookiecutter.project_name}}/project_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,6 @@ help you decide which tool to use for packaging.
- [Google style docstring examples](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
- The documentation is set up with the ReadTheDocs Sphinx theme.
- Check out its [configuration options](https://sphinx-rtd-theme.readthedocs.io/en/latest/).
- To generate HTML documentation, run `make html` in the `docs/` folder.
- To put the documentation on [ReadTheDocs](https://readthedocs.org), log in to your ReadTheDocs account, and import
the repository (under 'My Projects').
- Include the link to the documentation in your project's [README.md](README.md).
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=writingdocumentation)

## Coding style conventions and code quality
Expand Down

0 comments on commit 81662cf

Please sign in to comment.