AQ-AI / openaq-engine

http://www.aqai.xyz

BSD 3-Clause "New" or "Revised" License

2 stars 1 forks source link

35 create documentation for openaq engine #36

Closed ChristinaLast closed 1 year ago

ChristinaLast commented 1 year ago

Description

This branch adds the following:

[X] docs with all the setup instructions in .rst format
[X] sphinx build for documentation at https://aq-ai.github.io/openaq-engine/
[X] github action configuration to run on push and build sphinx docs.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

[X] This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes.

sphinx-build -b html docs/source docs/build

Checklist:

[X] My code follows the style guidelines of this project
[X] I have performed a self-review of my own code
[X] I have commented my code, particularly in hard-to-understand areas
[X] I have made corresponding changes to the documentation
[X] My changes generate no new warnings
[X] I have added tests that prove my fix is effective or that my feature works
[X] New and existing unit tests pass locally with my changes