You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Let's break this down:
16
16
-`docs` is the source directory.
17
17
-`docs/_build/html` is the output directory where the generated HTML files will be stored
18
18
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/)
20
20
21
21
## What's included:
22
22
Before building:
@@ -54,7 +54,7 @@ The pages generated using the command above are static HTML pages, for others to
54
54
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.*
55
55
56
56
### 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).
58
58
59
59
## Automatic API Documentation
60
60
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):
96
96
super().method_on_bar()
97
97
```
98
98
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