-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
3 changed files
with
18 additions
and
7 deletions.
There are no files selected for viewing
19 changes: 17 additions & 2 deletions
19
{{cookiecutter.project_name}}/.github/next_steps/03_readthedocs.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters