search

GiacomoPope / kyber-py

A pure python implementation of ML-KEM (FIPS 203) and CRYSTALS-Kyber
MIT License
194 stars 44 forks source link

Documentation needs love and care #27

Closed GiacomoPope closed 2 months ago

GiacomoPope commented 3 months ago

https://kyber-py.readthedocs.io/en/latest/

GiacomoPope commented 3 months ago

I added the main modules after linking, but apparently didn't connect it so it could automatically find all the python files for each module, so the docs are particularly broken after the latest refactoring... @tomato42

tomato42 commented 3 months ago

hmm, if we're moving things around anyway, maybe we could put all the sources into the src dir?

you can generate the module API files using

cd docs/
sphinx-apidoc -o source/ ../
GiacomoPope commented 3 months ago

Hmm I tried this and now there docs seem to have some structure but no information. I'm not experienced with Sphinx... I'll be more useful writing the docstrings themselves I think