Development Environment¶
- Author:
Alexander Eisele
- Date:
2024-01-17
Abstract¶
This section details the development environment and common tasks.
Initial Setup¶
Note
this currently applies only to the author’s setup.
To initially setup the development environment, do:
create a python virtualenv in that directory:
$ cd ~/develop/nexiles/nexiles.tools.api $ python -m venv venv
configure IntelliJ/PyCharm to use this venv Python interpreter
install the requirements:
$ . ./venv/bin/activate $ pip install -r requirements.txt $ pip install -e .
Common Tasks¶
Building The Documentation¶
The documentation is built using [sphinx](http://sphinx.pocoo.org):
$ . ./venv/bin/activate
$ fab build_docs
The built HTML documentation is now in _build/html.
To quickly preview the documentation in the browser, do:
$ . ./venv/bin/activate
$ fab docs-preview
To publish the docs to GitHub, do:
$ . ./venv/bin/activate
$ fab docs-publish