CdC-SI / eak-copilot

The official repository of the EAK-Copilot project as part of the Innovation Fellowship 2024.
https://cdc-si.github.io/eak-copilot/
GNU General Public License v3.0
4 stars 0 forks source link

Doc update to match refactored code #176

Closed Shi-Ho closed 1 month ago

Shi-Ho commented 1 month ago

Overview

Issue Reference:

- #89

Changes Made

- Added .github/workflows/sphinx-test.yml
- Rename .github/workflows/ci-sphinx.yml tp .github/workflows/sphinx-deploy.yml
- Update doc/conf.py
- Update doc/guidelines/sphinx.rst
- Update doc/topics/autocomplete/index.rst
- Update doc/topics/indexing/index.rst
- Update doc/topics/rag/index.rst

Testing

None

Screenshots

None

Additional Notes

I'm not sure it works because I couldn't download the package pyxDamerauLevenshtein, it's requesting some C++ compilator and I haven't looked into how to download it yet.

It is building fine when I'm commenting the import for this package though.

Also, is the "change mades" section in this form really useful since there's a "files changed" tab in the PR?

Requested Reviewers

@tabee @K-Schubert

tabee commented 1 month ago

Maybe rename the workflow from sphinx-test to sphinx-docs or something...