Shared artifacts concerning the Human Cell Atlas (HCA) Data Coordination Platform (DCP)
The documentation in this repository is formatted using reStructuredText
(.rst
).
If you're new to reStructuredText, check out the quick reference to get started, or the reStructuredText specifications for more specific questions.
We run a linter to ensure the RestructuredText files are correctly formatted. To run this on you system, first set up a python virtual environment:
python -m venv venv
Then activate the virtual environment by running:
source venv/bin/activate
Install the linter:
pip install rstcheck
As long as your virtual environment is active, you can run the linter with:
rstcheck -r .