search

GiacomoPope / kyber-py

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

Have default values shown at module level #53

Closed GiacomoPope closed 3 months ago

GiacomoPope commented 3 months ago

For example we have: https://kyber-py.readthedocs.io/en/latest/kyber_py.ml_kem.html

The header "Module contents" is empty, but it would be nice to show that really we can import ML_KEM128 etc directly from kyber_py.ml_kem - what's the best way to make Sphinx see this?

tomato42 commented 3 months ago

I think it's by defining __all__

But in general just having the module docstrings would help already

tomato42 commented 3 months ago

The ML-KEM parameters are actually documented in the docs now, so I've added the same for Kyber in https://github.com/GiacomoPope/kyber-py/pull/72