Development

Cloning

git clone git@github.com:ilexconf/ilexconf.git

Building

poetry install -E yaml -E console

Testing

poetry run pytest --cov

Building documentation

Full documentation is hosted at:

• ilexconf.com; and

• ilexconf.readthedocs.io.

Process:

• Documentation is written using reStructuredText and uses real code snippets from the unit tests and source code.

• Documentation is built with Sphinx using sphinx-material theme.

• For Github Pages documentation is built using Github Actions.

• Read the Docs builds their version automatically based on the .readthedocs.yml config in the project root directory.

Building:

make -C docs html

Then open the index.html file in the docs/_build directory in your browser.