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: README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ pip install --editable .
30
30
31
31
We reccomend starting with the ["getting started"](https://github.com/PRMS-Python/PRMS-Python/blob/master/notebooks/getting_started.ipynb)
32
32
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).
34
34
35
35
## Building documentation
36
36
@@ -44,11 +44,15 @@ make html
44
44
```
45
45
46
46
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.
49
49
50
50
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/
52
56
53
57
If it succeds and this is your first time making the html docs you will see a
54
58
new directory, `build/html`. If this is the first time you've
0 commit comments