From e2f45f177c3fb4139fd65b1d64c15bc1ff1bc5d4 Mon Sep 17 00:00:00 2001 From: Adam Tyson Date: Mon, 16 Oct 2023 15:39:46 +0100 Subject: [PATCH 1/2] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d9fc50..8020162 100644 --- a/README.md +++ b/README.md @@ -295,7 +295,7 @@ sphinx-build docs/source docs/build ``` ### Publishing the documentation -We have included an extra GitHub actions workflow in `.github/workflows/docs_build_and_depoly.yml` that will build the documentation and deploy it to [GitHub pages](https://pages.github.com/). +We have included an extra GitHub actions workflow in `.github/workflows/docs_build_and_deploy.yml` that will build the documentation and deploy it to [GitHub pages](https://pages.github.com/). * The build step is triggered every time a pull request is opened or a push is made to the `main` branch. This way you can make sure that the documentation does not break before merging your changes. * The deployment is triggered only when a tag is present (see [Automated versioning](#automated-versioning)). This ensures that new documentation versions are published in tandem with the release of a new package version on PyPI (see [GitHub actions workflow](#github-actions-workflow)). * The published docs are by default hosted at `https://.github.io//`. To enable hosting, you will need to go to the settings of your repository, and under the "Pages" section, select the `gh-pages` branch as the source for your GitHub pages site. From ed5a6faad568208d2c6293fb34ddf19e27ceda00 Mon Sep 17 00:00:00 2001 From: Adam Tyson Date: Mon, 16 Oct 2023 15:40:54 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8020162..1b898db 100644 --- a/README.md +++ b/README.md @@ -299,7 +299,7 @@ We have included an extra GitHub actions workflow in `.github/workflows/docs_bui * The build step is triggered every time a pull request is opened or a push is made to the `main` branch. This way you can make sure that the documentation does not break before merging your changes. * The deployment is triggered only when a tag is present (see [Automated versioning](#automated-versioning)). This ensures that new documentation versions are published in tandem with the release of a new package version on PyPI (see [GitHub actions workflow](#github-actions-workflow)). * The published docs are by default hosted at `https://.github.io//`. To enable hosting, you will need to go to the settings of your repository, and under the "Pages" section, select the `gh-pages` branch as the source for your GitHub pages site. -* A popular alternative to GitHub pages for hosting the documentaiton is [Read the Docs](https://readthedocs.org/). To enable hosting on Read the Docs, you will need to create an account on the website and follow the instructions to link your GitHub repository to your Read the Docs account. +* A popular alternative to GitHub pages for hosting the documentation is [Read the Docs](https://readthedocs.org/). To enable hosting on Read the Docs, you will need to create an account on the website and follow the instructions to link your GitHub repository to your Read the Docs account. ### Docstrings and API documentation The journey towards good documentation starts with writing docstrings for all functions in your module code. In the example `math.py` and `greetings.py` modules you will find some docstrings that you can use as a template. We have written the example docstrings following the [numpy style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html) but you may also choose another widely used style, such as the [Google style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).