Update docs

.gitignore

@@ -138,3 +138,6 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+_build/
+docs/api/

docs/_templates/package.rst_t

@@ -0,0 +1,54 @@
+
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{%- macro toctree(docnames) -%}
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{%- if is_namespace %}
+{{- pkgname | e | heading }}
+{% else %}
+{{- pkgname | e | heading }}
+{% endif %}
+
+{%- if is_namespace %}
+.. py:module:: {{ pkgname }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
+
+{%- if subpackages %}
+
+{{ toctree(subpackages) }}
+{% endif %}
+
+{%- if submodules %}
+{% if separatemodules %}
+{{ toctree(submodules) }}
+{% else %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- submodule | e | heading(2) }}
+{% endif %}
+{{ automodule(submodule, automodule_options) }}
+{% endfor %}
+{%- endif %}
+{%- endif %}
+
+{%- if not modulefirst and not is_namespace %}
+Module contents
+---------------
+
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}

docs/conf.py

@@ -7,8 +7,10 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 import os
 from sphinx_pyproject import SphinxConfig
-module_dir = os.path.join(__file__, "../src/mokka")
+
+module_dir = os.path.join(os.path.dirname(__file__), "../src/mokka")
 
 config = SphinxConfig("../pyproject.toml", globalns=globals())
 
-author
+author=config.author
+project=config.name

docs/index.rst

@@ -1,17 +1,16 @@
-.. mokka documentation master file, created by
-   sphinx-quickstart on Wed Jan 11 17:28:53 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to mokka's documentation!
 ===================================
+MOKKa
+===================================
+
+Welcome to the documentation of the MOKKa package.
+This package aims to collect useful building blocks for physical layer simulations of communication systems implemented in various machine learning frameworks.
 
 
 .. toctree::
-   :maxdepth: 3
-   :caption: Contents:
+   :maxdepth: 2
+   :caption: Contents
 
-   source/mokka
+   api/mokka
 
 Indices and tables
 ==================

docs/make-docs.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+rm -rf docs/api
+sphinx-apidoc -o docs/api -E -M -T -d 3 -t docs/_templates src/
+sphinx-build -b html docs/ _build/html

pyproject.toml

@@ -7,7 +7,7 @@ requires = [
 build-backend = "flit_core.buildapi"
 
 [project]
-name = "mokka"
+name = "MOKKa"
 readme = "README.md"
 requires-python = ">=3.9"
 license = {file = "COPYING"}
@@ -29,7 +29,7 @@ dependencies = [
 version = "1.0.0"
 description = "A machine learning toolbox for communications engineering"
 keywords = ["communications engineering", "machine learning"]
-#dynamic = ["version", "description"]
+# dynamic = ["version", "description"]
 
 [project.optional-dependencies]
 torch = [
@@ -50,6 +50,7 @@ dev = [
     "python-lsp-black",
     "sphinx",
     "sphinx-pyproject",
+    "sphinx_rtd_theme"
 ]
 remotelog = [
     "wandb",
@@ -69,12 +70,14 @@ language = "en"
 package_root = "mokka"
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx_rtd_theme",
+    "sphinx.ext.mathjax",
 ]
 templates_path = [ "_templates", ]
 html_static_path = [ "_static", ]
 source_suffix = ".rst"
 master_doc = "index"
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 autodoc_exclude_members = [
     "__dict__",
     "__class__",