diff --git a/README.md b/README.md index 86a72ea..ea02c1f 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,17 @@ Contributions are welcome. - Python 3.7+ - Pip - Other listed in requirements.txt +## Documentation -## Running +This project uses automated tools to generate and maintain up-to-date documentation. The documentation is generated using AI, ensuring it reflects the latest changes in the codebase. + +To generate the documentation, run the following command: + +```bash +# Command to generate documentation +``` + +The generated documentation will be available in the `docs/` directory. - Clone the repo using @@ -85,4 +94,4 @@ uvicorn main:app

- \ No newline at end of file + diff --git a/requirements.txt b/requirements.txt index 904d938..9c434fb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -52,5 +52,6 @@ typing-extensions==3.7.4.3 ujson==3.2.0 urllib3==1.26.5 uvicorn==0.13.4 +sphinx==4.5.0 watchgod==0.7 websockets==9.1