search

emse-sas / sca_framework

Demonstration application for RO and TDC based SCA attack on the AES 128
MIT License
1 stars 0 forks source link

Python documentation #32

Closed samiBendou closed 4 years ago

samiBendou commented 4 years ago

Complete Python documentation

samiBendou commented 4 years ago

https://realpython.com/documenting-python-code/#commenting-vs-documenting-code

samiBendou commented 4 years ago

https://docs.python.org/3/library/typing.html

samiBendou commented 4 years ago

https://numpydoc.readthedocs.io/en/latest/format.html#method-docstrings

samiBendou commented 4 years ago

https://www.sphinx-doc.org/en/master/

samiBendou commented 4 years ago

GitHub pages integration must be done globally from ./docs directory not ./py_sca/docs. It is better to wait until the global doc is formated and reviewed to integration GitHub pages.

To generate current Python doc do the following from root directory :

$ cd docs/sources/sphinx
$ make html

This will generate an html website based on the Python documentation at the directory docs/sources/build/all/html. To view the website just run the index.html file in your web browser.