openfoodfacts / search-a-licious

šŸŠšŸ”Ž A pluggable search service for large collections of objects (like Open Food Facts)
https://search.openfoodfacts.org
GNU Affero General Public License v3.0
6 stars 4 forks source link

Publish documentation #184

Open alexgarel opened 1 week ago

alexgarel commented 1 week ago
### Tasks
- [ ] use mkdocs and material theme
- [ ] Use sphinx to create the APIĀ documentation in a specific folder
- [ ] Use [autodoc-pydantic](https://autodoc-pydantic.readthedocs.io/en/stable/index.html) with Sphinx to auto-generate configuration documentation
- [ ] Eventually generate OpenAPI documentation to have it published standalone (with redoc or rapidoc)
- [ ] Add a check in CI for documentation build
- [ ] Publish all docs to github pages

See other projects to re-use scripts that do that:

alexgarel commented 1 week ago

@Kout95 this is a thing to do also.

I can take care of mkdocs part, because I did it a lot of times.

But if you are ok to handle the sphinx build, IĀ would be glad :-) The most important part is to generate the documentation for the configuration because it enables centralizing precise documentation there.