Repo documentation

We use GitHub Pages to publish our documentation for all projects in this repository. The entrypoint for the overall Fairo repository is the index.html in this folder.

Add project to documentation page

To add your project's documentation to the repo:

1. In your CircleCI job, generate your documentation in the required environment (e.g. using Sphinx). Each project should be responsible for generating its own documentation, including any required environment setup.
2. Run the persist_docs command after generating your documentation with parameters project_name (name of directory under the project root directory) and relative_path (relative path from project root directory to the folder containing the generated docs). It will automatically be pushed to GitHub Pages when merged to main branch at facebookresearch.github.io/fairo.
3. When ready, add a link/logo to your-project-name in index.html.