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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -118,13 +118,13 @@ In order to test and/or publish changes, activate a conda environment that has a
118
118
119
119
Make sure you have an active installation of Sphinx as per [Publishing Changes](#publishing-changes), run the set of Sphinx validation command(s) to check that the static files that Sphinx will create to be served on the website are written properly:
120
120
```
121
-
diffpy.github.io (source)$ make Makefile linkcheck SPHINXOPTS="-W"
121
+
diffpy.github.io (source)$ make linkcheck SPHINXOPTS="-W"
122
122
```
123
123
*NOTE:* the `"-W"` flag forces warnings to be treated as errors. If you believe there is a falsely reported warning that should be ignored that is preventing the test from passing, rerun the above command with the `SPHINXOPTS="-W"` portion omitted.
124
124
125
125
Additionally, one can visually/user-experience validate that the changes are what is expected by running:
126
126
```
127
-
diffpy.github.io (source)$ make Makefile html
127
+
diffpy.github.io (source)$ make html
128
128
```
129
129
Then opening `/_build/html/index.html` which will open a local instance of the website with the proposed changes in place.
130
130
@@ -138,17 +138,17 @@ In order to update the contents of [diffpy.org][site], create a new branch off o
138
138
139
139
First, follow the steps outlines in [Testing Changes](#testing-changes) to verify that the changes won't mess things up (too bad). Note that these tests, as they currently exist, are not extensive and it's quite possible that something indeed may appear incorrectly on the website (hence the manual review portion). After reviewing the changes, have Sphinx generate the static files to be hosted on the website:
140
140
```
141
-
diffpy.github.io (source)$ make Makefile html
141
+
diffpy.github.io (source)$ make html
142
142
```
143
143
144
144
Prepare the changes to be published:
145
145
```
146
-
diffpy.github.io (source)$ make Makefile publish-prepare
146
+
diffpy.github.io (source)$ make publish-prepare
147
147
```
148
148
149
149
Finally, publish the changes:
150
150
```
151
-
diffpy.github.io (source)$ make Makefile publish-push
0 commit comments