Skip to content

Commit 67fdfe0

Browse files
authored
Merge pull request #48 from connorjbracy/cbracy_fixing_readme
Removing unnecessary part of make calls
2 parents 1b17a69 + d8dc357 commit 67fdfe0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,13 @@ In order to test and/or publish changes, activate a conda environment that has a
118118

119119
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:
120120
```
121-
diffpy.github.io (source)$ make Makefile linkcheck SPHINXOPTS="-W"
121+
diffpy.github.io (source)$ make linkcheck SPHINXOPTS="-W"
122122
```
123123
*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.
124124

125125
Additionally, one can visually/user-experience validate that the changes are what is expected by running:
126126
```
127-
diffpy.github.io (source)$ make Makefile html
127+
diffpy.github.io (source)$ make html
128128
```
129129
Then opening `/_build/html/index.html` which will open a local instance of the website with the proposed changes in place.
130130

@@ -138,17 +138,17 @@ In order to update the contents of [diffpy.org][site], create a new branch off o
138138

139139
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:
140140
```
141-
diffpy.github.io (source)$ make Makefile html
141+
diffpy.github.io (source)$ make html
142142
```
143143

144144
Prepare the changes to be published:
145145
```
146-
diffpy.github.io (source)$ make Makefile publish-prepare
146+
diffpy.github.io (source)$ make publish-prepare
147147
```
148148

149149
Finally, publish the changes:
150150
```
151-
diffpy.github.io (source)$ make Makefile publish-push
151+
diffpy.github.io (source)$ make publish-push
152152
```
153153

154154

0 commit comments

Comments
 (0)