Getting Started¶
Welcome to the ALC AiiDAlab app’s developer guide.
Running The Test Suite¶
There is a testing framework in place which uses pytest. To run the test suite locally, run:
cd tests
pytest
Building The Documentation¶
The documentation for the ALC’s AiiDAlab app is written using sphinx
and is contained within the /docs/ folder. It can be built via,
cd docs
make html
Alongside the user and developer documentation an API reference is provided via the sphinx-autodoc extension. This can be automatically updated to include new modules using the command line tool provided with sphinx-autodoc,
sphinx-apidoc -o ./docs/source/api_docs/ ./src/aiidalab_alc/
or any new modules can be added manually. All docstrings are to be written in numpy style for consistency.