Skip to content

Commit 0937054

Browse files
committed
docs: update install version and add build instructions
1 parent 2234d9a commit 0937054

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@ scaffolds a new project using the bundled cookiecutter template.
2222
Comprehensive documentation and tutorials are available on the
2323
[GitHub Pages site](https://taskbeacon.github.io/psyflow/).
2424

25+
### Building the documentation
26+
27+
To generate the HTML docs locally:
28+
29+
```bash
30+
pip install -r docs/requirements.txt
31+
sphinx-build -b html docs docs/_build/html
32+
```
33+
34+
Open `docs/_build/html/index.html` in a browser to view them.
35+
2536
## Publishing to PyPI
2637

2738
Releases are automated with GitHub Actions. Any push to the `main` branch

docs/tutorials/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ pip install psychopy
2727
You can install psyflow directly from PyPI:
2828

2929
```bash
30-
pip install psyflow==0.1.0
30+
pip install psyflow==0.1.1
3131
```
3232

3333
Or if you prefer to work with the source code:

0 commit comments

Comments
 (0)