This repository holds the source of the official website of Label Sleuth. The actual website pages are automatically built from the source files using sphinx.
The website can be viewed at: https://www.label-sleuth.org
The documentation is automatically built and deployed to the location above upon each PR to the main branch of this repository, after receiving approval by the maintainers.
If you want to test the documentation locally, follow the steps below:
- Switch to the
docsdirectory
cd docs
- Install dependencies
pip install -r requirements.txt
- Run the sphinx build
make html
- Use your web browser to open the following page (relative to your current directory):
_build/html/index.html