Girder 4 documentation materials.
You can use poetry
to build and view the documentation locally. There are two
ways to do it.
- Run
poetry shell
to build the dependencies and drop into a virtualenv. - Run
poetry run task build
to build the documentation. - Run
poetry run task serve
to serve the docs on port 8000 (orpoetry run task serve 8001
to use a different port of your choice).
- Run
poetry shell
to build the dependencies and drop into a virtualenv. - Run
poetry run task watch
to build and serve the docs on port 8000 (orpoetry run task watch PORT=8001
to use a different port of your choice). Changes to the documentation source code will cause an automatic rebuild.