Skip to content

Commit edf7f69

Browse files
authored
Enhance README with GitHub Pages links and workflow example
Added link to GitHub Pages site for built documentation and provided an example workflow link for GitHub Pages deployment.
1 parent 90e86d3 commit edf7f69

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎docs/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Let's break this down:
1616
- `docs` is the source directory.
1717
- `docs/_build/html` is the output directory where the generated HTML files will be stored
1818

19-
**The compiled docs will be in the `docs/_build/html/` directory and can be viewed by opening `index.html`.**
19+
**The compiled docs will be in the `docs/_build/html/` directory and can be viewed by opening `index.html`.** You can also view the built docs by looking at the GitHub Pages site for this repository: [http://omsf.io/OMSF_docs_template/](http://omsf.io/OMSF_docs_template/)
2020

2121
## What's included:
2222
Before building:
@@ -54,7 +54,7 @@ The pages generated using the command above are static HTML pages, for others to
5454
A configuration file for [Read The Docs](https://readthedocs.org/) (readthedocs.yaml) is included in the top level of the repository. To use Read the Docs to host your documentation, go to https://readthedocs.org/ and connect this repository. *You may need to change your default branch to `main` under Advanced Settings for the project.*
5555

5656
### Using GitHub Pages
57-
You will need to create a workflow to deploy your documentation to a GitHub pages site and then adjust the settings in your repository to have them automatically update when changes are made to the main branch. This [tutorial](https://coderefinery.github.io/documentation/gh_workflow/) outlines the steps, though the workflow can be made much more sophsticated based on your project's needs. Learn more about GitHub workflows [here](https://docs.github.com/en/actions/how-tos/write-workflows).
57+
You will need to create a workflow (you can find an example [here](https://github.com/omsf/OMSF_docs_template/blob/main/.github/workflows/documentation.yml)) to deploy your documentation to a GitHub pages site and then adjust the settings in your repository to have them automatically update when changes are made to the main branch. This [tutorial](https://coderefinery.github.io/documentation/gh_workflow/) outlines the steps, though the workflow can be made much more sophsticated based on your project's needs. Learn more about GitHub workflows [here](https://docs.github.com/en/actions/how-tos/write-workflows).
5858

5959
## Automatic API Documentation
6060
A configuration for automatically documenting [OpenFF](https://openforcefield.org/) software (as an example) with AutoSummary is included. The project is processed and documented as follows:
@@ -96,4 +96,4 @@ class foo(bar):
9696
super().method_on_bar()
9797
```
9898

99-
To explore more examples of automatic documentation, open `docs/_build/html/index.rst` and look through the `my_project` tab. You can find the matching code in the `src` directory.
99+
To explore more examples of automatic documentation, open `docs/_build/html/index.rst` and look through the `my_project` tab. You can find the matching code in the `src` directory.

0 commit comments

Comments
 (0)