Hi! Welcome to our contributors portal.
This is currently being built, as of July 2024. Come back in a few weeks, or visit a first version at artefactual.github.io
- The Community Team.
To build the website locally, you will need to install:
pip install Sphinx
pip install furo
You will then be able to use make html to build the HTML version of the website, which will be in build/html.
At the moment speaking and for the foreseeable future, we expect that contributions will be made by Artefactual staff from time to time. We do not expect any external contributor to make a PR, but you are welcome to file an issue if you have general questions about contributing.
We use pre-commit hooks to check for formatting with doc8 and sphinx-lint.
You should be able to use pre-commit install to install the hooks.