HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

use poetry run instead of poetry shell

Browse Source
This commit is contained in:
Josh de Leeuw 2022-05-19 13:42:50 -04:00
parent 153e13f621
commit c33b9feda2
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/developers/documentation.md
View File

@ -12,13 +12,9 @@ To build a local copy of the docs, you will need to install `mkdocs`, `mkdocs-ma
Run the command `poetry install` in the root directory of jsPsych to install `mkdocs`, `mkdocs-material`, and their dependencies.
## Launch a poetry shell
Poetry installs dependencies in a virtual environment. Run `poetry shell` to open a new shell configured to use the virtual environment that poetry generated.
## Building a local copy of the docs
Run `mike deploy [version] -u` to build a new version of the documentation or to override an existing version. For example, if you are testing an edit to version `7.2` of the documentation, run `mike deploy 7.2 -u`.
Run `poetry run mike deploy [version] -u` to build a new version of the documentation or to override an existing version. For example, if you are testing an edit to version `7.2` of the documentation, run `poetry mike deploy 7.2 -u`.
This will build the documentation and commit it directly to the `gh-pages` branch.
@ -26,4 +22,4 @@ We use [`mike`](https://github.com/jimporter/mike) instead of `mkdocs` for the b
## Viewing the local docs
Run `mike serve` to launch a local webserver. The docs will be viewable at `http://localhost:8000`.
Run `poetry run mike serve` to launch a local webserver. The docs will be viewable at `http://localhost:8000`.