Skip to content

Commit b867fe3

Browse files
authored
update readme documentation info
1 parent 2071ec0 commit b867fe3

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ pip install --editable .
3030

3131
We reccomend starting with the ["getting started"](https://github.com/PRMS-Python/PRMS-Python/blob/master/notebooks/getting_started.ipynb)
3232
Jupyter notebook for file structure rules that PRMS-Python uses and then
33-
moving on to other example notebooks in the [`notebooks` directory](https://github.com/PRMS-Python/PRMS-Python/tree/master/notebooks). Online documentation is also available [here](https://prms-python.github.io/docs/).
33+
moving on to other example notebooks in the [`notebooks` directory](https://github.com/PRMS-Python/PRMS-Python/tree/master/notebooks). Online documentation is available [here](https://prms-python.github.io/PRMS-Python/build/html/index.html).
3434

3535
## Building documentation
3636

@@ -44,11 +44,15 @@ make html
4444
```
4545

4646
If it fails because of missing dependencies, just install the dependencies
47-
it says it's missing. I don't know why it's asking for some dependencies
48-
right now.
47+
it says it's missing. Publishing the docs is now done automatically with any
48+
commits are pushed to the master branch.
4949

5050

51-
<!--- commented the modification of online docs for now
51+
<!--- commented the published of online docs the old way
52+
The method I employed was found on the Sphinx repository as an issue
53+
that did exactly what I wanted: https://github.com/sphinx-doc/sphinx/issues/3382
54+
essentially using the new github publish docs from master branch doc folder
55+
but using a fake index.html to redirect github to the one under docs/build/html/
5256
5357
If it succeds and this is your first time making the html docs you will see a
5458
new directory, `build/html`. If this is the first time you've

0 commit comments

Comments
 (0)