📄 Documentation

Introduction

DEEP’s documentation is built on top of Sphinx and uses a theme provided by Read the Docs. We accept contributions to the documentation of the DEEP project too.

Contributions to Documentation

Contributions to DEEP’s documentation must adhere to the contribution guidelines, just like any other code contribution. DEEP’s documentation is generated as a static page using Sphinx. During deployment, the docs are generated using a pre-deployment pipeline in a similar manner. For local creation of docs, refer the notes below.

Steps to generate DEEP docs locally

1. Navigate to the documentation folder:

   cd docs/
   

2. Install sphinx and supporting packages:

   pip install -r requirements.txt
   

3. Generate static documentation locally:

   make html
   

4. View the generated docs by opening the index file in your browser, at the following path: <path-to-project>/docs/_build/html/index.html

Useful References

• sphinx-autobuild is a tool that auto-builds the documentation everytime a change is detected in the docs/ folder

• rst Cheatsheet for a handy reference on reStructuredText, the markup language used by Sphinx