Skip to content

Commit e18d898

Browse files
authored
Copyedits for grammar and standardization
1 parent dab5c2c commit e18d898

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README-dev.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
There are two ways to build the documentation. One is the plain one, where
66
the plain Sphinx output is desired, and the other is the themed version that
7-
is meant to integrate with the web site.
7+
is meant to integrate with the website.
88

99
!!! Note
1010

@@ -30,15 +30,15 @@ The output will be in `docs/.build`
3030

3131
### Building the Themed Documentation
3232

33-
This builds the themed version of the docs as well as the web site. The steps
33+
This builds the themed version of the docs as well as the website. The steps
3434
are:
3535

3636
1. Make sure you have the dependencies installed:
3737
```sh
3838
pip install -r requirements-docs.txt
3939
```
4040

41-
2. Build the web site, which builds the themed version of the documentation
41+
2. Build the website, which builds the themed version of the documentation
4242
automatically:
4343
```
4444
web/build.sh
@@ -55,16 +55,16 @@ server. A simple way to do so is:
5555

5656
where `<port>` is a port number to start the HTTP server on.
5757

58-
When developing the web site, a convenient script is `web/watch.sh`, which can
58+
When developing the website, a convenient script is `web/watch.sh`, which can
5959
monitor the source directories and re-build when files are modified. This
60-
requires `inotify` which may or may not be available on your platform.
60+
requires `inotify`, which may or may not be available on your platform.
6161

6262

63-
### Release process
63+
### Release Process
6464

6565
Here are the steps for putting out a fresh release to Pypi.
6666

67-
1. Create a new branch from main, and make release specific updates:
67+
1. Create a new branch from main and make release specific updates:
6868
* Update `src/psij/version.py` to the new version number
6969

7070
2. Use the standard PR process and get changes from the above step merged to main.
@@ -73,6 +73,6 @@ Here are the steps for putting out a fresh release to Pypi.
7373
setup tokens on your machine.
7474

7575
4. Run `make VERSION="version string" tag-and-release`. This will:
76-
1. Create and push tags to github
77-
2. Build the package
78-
3. Push built package to Pypi.
76+
* Create and push tags to GitHub.
77+
* Build the package.
78+
* Push built package to Pypi.

0 commit comments

Comments
 (0)