Skip to content

Commit 6dab65a

Browse files
tomato42tomato42
committed
add bare skeleton of API docs for the project
Signed-off-by: Hubert Kario <[email protected]>
1 parent 5beb25b commit 6dab65a

19 files changed

+241
-1
lines changed

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
**/.DS_Store
2-
__pycache__
2+
__pycache__
3+
docs/build

‎.readthedocs.yaml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/source/conf.py
17+
18+
# If using Sphinx, optionally build your docs in additional formats such as PDF
19+
# formats:
20+
# - pdf
21+
22+
# Optionally declare the Python requirements required to build your docs
23+
python:
24+
install:
25+
- requirements: requirements.txt
26+
- requirements: docs/requirements.txt

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx-rtd-theme

‎docs/source/aes256_ctr_drbg.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
aes256\_ctr\_drbg module
2+
========================
3+
4+
.. automodule:: aes256_ctr_drbg
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/api.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
API
2+
===
3+
4+
.. toctree::
5+
aes256_ctr_drbg
6+
benchmark_kyber
7+
kyber
8+
ml_kem
9+
modules
10+
modules_generic
11+
ntt_helper
12+
polynomials
13+
polynomials_generic
14+
run_kyber
15+
utils

‎docs/source/benchmark_kyber.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
benchmark\_kyber module
2+
=======================
3+
4+
.. automodule:: benchmark_kyber
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/conf.py

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Code location -----------------------------------------------------------
7+
8+
import os
9+
import sys
10+
11+
sys.path.insert(0, os.path.abspath("../.."))
12+
13+
# -- Project information -----------------------------------------------------
14+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
15+
16+
project = "kyber-py"
17+
copyright = "2024, Giacomo Pope"
18+
author = "Giacomo Pope"
19+
release = "0.3.0-alpha1"
20+
21+
# -- General configuration ---------------------------------------------------
22+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
23+
24+
extensions = [
25+
"sphinx.ext.autodoc",
26+
"sphinx.ext.autosummary",
27+
"sphinx.ext.intersphinx",
28+
]
29+
30+
templates_path = ["_templates"]
31+
exclude_patterns = []
32+
33+
34+
# -- Options for HTML output -------------------------------------------------
35+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
36+
37+
html_theme = "sphinx_rtd_theme"
38+
html_static_path = ["_static"]
39+
intersphinx_mapping = {"Python": ("https://docs.python.org/", None)}

‎docs/source/index.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. kyber-py documentation master file, created by
2+
sphinx-quickstart on Fri Jul 19 18:19:51 2024.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to kyber-py's documentation!
7+
====================================
8+
9+
Welcome to the documentation of the kyber-py package.
10+
This is a pure-python implementation of th ML-KEM (formely Kyber) algorithm
11+
for cryptographic exchange of keys.
12+
13+
.. toctree::
14+
:maxdepth: 2
15+
:caption: Contents:
16+
17+
api
18+
19+
20+
21+
Indices and tables
22+
==================
23+
24+
* :ref:`genindex`
25+
* :ref:`modindex`
26+
* :ref:`search`

‎docs/source/kyber.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
kyber module
2+
============
3+
4+
.. automodule:: kyber
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ml_kem.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ml\_kem module
2+
==============
3+
4+
.. automodule:: ml_kem
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/modules.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
modules module
2+
==============
3+
4+
.. automodule:: modules
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/modules_generic.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
modules\_generic module
2+
=======================
3+
4+
.. automodule:: modules_generic
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ntt_helper.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ntt\_helper module
2+
==================
3+
4+
.. automodule:: ntt_helper
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/polynomials.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
polynomials module
2+
==================
3+
4+
.. automodule:: polynomials
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/polynomials_generic.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
polynomials\_generic module
2+
===========================
3+
4+
.. automodule:: polynomials_generic
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/run_kyber.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
run\_kyber module
2+
=================
3+
4+
.. automodule:: run_kyber
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/utils.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
utils module
2+
============
3+
4+
.. automodule:: utils
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)