aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorJ08nY2019-12-22 02:39:49 +0100
committerJ08nY2019-12-22 02:39:49 +0100
commit67fa43ddd53325a6318076356e8ab8c4d76917bc (patch)
treefa345f71ea3b226b1dde0d9c538becf9cf9af116 /docs
parent77c3141139be0c3f851dff92f8da6f463e29d57c (diff)
downloadpyecsca-67fa43ddd53325a6318076356e8ab8c4d76917bc.tar.gz
pyecsca-67fa43ddd53325a6318076356e8ab8c4d76917bc.tar.zst
pyecsca-67fa43ddd53325a6318076356e8ab8c4d76917bc.zip
Refactor ScalarMult.
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile8
-rw-r--r--docs/conf.py9
2 files changed, 11 insertions, 6 deletions
diff --git a/docs/Makefile b/docs/Makefile
index c12361e..689e069 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -14,11 +14,9 @@ help:
apidoc:
mkdir -p api/codegen/
- sphinx-apidoc ../pyecsca/ --ext-autodoc -f -e -o api/
- sed -i "s/automodule:: /automodule:: pyecsca./g" api/*.rst
- sphinx-apidoc ../../pyecsca-codegen/pyecsca/ --ext-autodoc -f -e -o api/codegen/
- sed -i "s/automodule:: /automodule:: pyecsca./g" api/codegen/*.rst
- echo " codegen/codegen" >> api/modules.rst
+ sphinx-apidoc ../pyecsca/ --implicit-namespaces --ext-autodoc -f -e -o api/
+ sphinx-apidoc ../../pyecsca-codegen/pyecsca/ --implicit-namespaces --ext-autodoc --no-toc -f -e -o api/codegen/
+ echo " codegen/pyecsca.codegen" >> api/modules.rst
.PHONY: help apidoc Makefile
diff --git a/docs/conf.py b/docs/conf.py
index f219c17..2b1ee9c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -199,4 +199,11 @@ epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
-todo_include_todos = True \ No newline at end of file
+todo_include_todos = True
+
+autodoc_default_options = {
+ "members": True,
+ "undoc-members": True,
+ "inherited-members": True,
+ "show-inheritance": True
+} \ No newline at end of file