Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
palewire committed Jul 17, 2023
1 parent 2677b59 commit 699e358
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: docs

docs:
cd ./docs/ && make livehtml
cd ./docs/ && pipenv run make livehtml
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ After installing the repository, the Sphinx documentation can be edited in the
First install the requirements.

```bash
$ pip install -r requirements-dev.txt
pipenv install
```

Fire up the test server, which will automatically update to show changes made
to the restructured text files in the ``docs`` directory.

```bash
$ make docs
make docs
```

Open ``http://localhost:8000`` in your browser and start making changes.

0 comments on commit 699e358

Please sign in to comment.