Merge pull request #8 from HEP-Alliance/main

Add HEP-Alliance masked and unmasked AES designs

MaskedAndUnmaskedAES/doc/.gitignore

@@ -0,0 +1,2 @@
+build/
+build.log

MaskedAndUnmaskedAES/doc/Makefile

@@ -0,0 +1,39 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS     ?= -j auto -w build.log
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+.DEFAULT_GOAL := docs
+
+#docs: clean setup build display
+docs: clean  build display
+
+
+.ONESHELL:
+clean:
+	@rm -rf $(BUILDDIR)
+	@rm -rf build.log
+
+build:
+	@$(SPHINXBUILD) -M "html" "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+.ONESHELL:
+display:
+	@cd $(BUILDDIR)/html
+	@xdg-open index.html

MaskedAndUnmaskedAES/doc/requirements.txt

@@ -0,0 +1,2 @@
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1

MaskedAndUnmaskedAES/doc/source/conf.py

@@ -0,0 +1,35 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'Amazing Design'
+copyright = '2024, IHP Open PDK'
+author = 'Amazing Design Authors'
+
+release = '0.1'
+version = '0.1.0'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

MaskedAndUnmaskedAES/doc/source/designdata.rst

@@ -0,0 +1,5 @@
+Design data and design process description
+############################################
+
+The design currently lives in https://github.com/HEP-Alliance/masked-aes-tapeout and might be moved here later.
+

MaskedAndUnmaskedAES/doc/source/index.rst

@@ -0,0 +1,21 @@
+
+********************************************************
+Welcome to Amazing Design Open Source PDK documentation!
+********************************************************
+
+
+.. toctree::
+    :hidden:
+
+    specification
+    designdata
+    validation
+
+.. warning::
+    This documentation is currently a **work in progress**.
+
+.. image:: _static/IHP_logo.png
+    :align: center
+    :alt: IHP Logo Image.
+    :width: 400
+

MaskedAndUnmaskedAES/doc/source/specification.rst

@@ -0,0 +1,6 @@
+Specification of the Amazing Design
+###################################
+
+
+Provide your specification here. Consider comparison with other stat of an art designs. 
+

MaskedAndUnmaskedAES/doc/source/validation.rst

@@ -0,0 +1,6 @@
+Validation  of the Amazing Design
+#################################
+
+
+Document the measurement results here.
+