add docs

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# 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)

docs/_autoapi_templates/python/class.rst

@@ -0,0 +1,79 @@
+{% if obj.display %}
+:py:class:`{{ obj.id }} <{{ obj.id }}>`
+==========={{ "=" * 2 * (obj.id|length + 2) }}
+
+.. _{{ obj.id }}:
+
+.. py:{{ obj.type }}:: {{ obj.id }}{% if obj.args %}({{ obj.args }}){% endif %}
+
+{% for (args, return_annotation) in obj.overloads %}
+      {{ " " * (obj.type | length) }}   {{ obj.id }}{% if args %}({{ args }}){% endif %}
+
+{% endfor %}
+
+
+   {% if obj.bases %}
+   {% if "show-inheritance" in autoapi_options %}
+   Bases: {% for base in obj.bases %}{{ base|link_objs }}{% if not loop.last %}, {% endif %}{% endfor %}
+   {% endif %}
+
+
+   {% if "show-inheritance-diagram" in autoapi_options and obj.bases != ["object"] %}
+   .. autoapi-inheritance-diagram:: {{ obj.obj["full_name"] }}
+      :parts: 1
+      {% if "private-members" in autoapi_options %}
+      :private-bases:
+      {% endif %}
+
+   {% endif %}
+   {% endif %}
+   {% if obj.docstring %}
+   {{ obj.docstring|indent(3) }}
+   {% endif %}
+   {% if "inherited-members" in autoapi_options %}
+   {% set visible_classes = obj.classes|selectattr("display")|list %}
+   {% else %}
+   {% set visible_classes = obj.classes|rejectattr("inherited")|selectattr("display")|list %}
+   {% endif %}
+   {% for klass in visible_classes %}
+   {{ klass.render()|indent(3) }}
+   {% endfor %}
+   {% if "inherited-members" in autoapi_options %}
+   {% set visible_properties = obj.properties|selectattr("display")|list %}
+   {% else %}
+   {% set visible_properties = obj.properties|rejectattr("inherited")|selectattr("display")|list %}
+   {% endif %}
+   {% for property in visible_properties %}
+   {{ property.render()|indent(3) }}
+   {% endfor %}
+   {% if "inherited-members" in autoapi_options %}
+   {% set visible_attributes = obj.attributes|selectattr("display")|list %}
+   {% else %}
+   {% set visible_attributes = obj.attributes|rejectattr("inherited")|selectattr("display")|list %}
+   {% endif %}
+   {% for attribute in visible_attributes %}
+   {{ attribute.render()|indent(3) }}
+   {% endfor %}
+   {% if "inherited-members" in autoapi_options %}
+   {% set visible_methods = obj.methods|selectattr("display")|list %}
+   {% else %}
+   {% set visible_methods = obj.methods|rejectattr("inherited")|selectattr("display")|list %}
+   {% endif %}
+   Methods
+   ~~~~~~~
+
+   .. autoapisummary::
+
+    {% for method in visible_methods %}
+      {{ method.id }}
+    {% endfor %}
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+{% for method in visible_methods %}
+   {{ method.short_name }}<{{ method.short_name }}>
+{% endfor %}
+
+{% endif %}

docs/_autoapi_templates/python/function.rst

@@ -0,0 +1,20 @@
+{% if obj.display %}
+:py:func:`{{ obj.id }} <{{ obj.id }}>`
+=========={{ "=" * 2 * (obj.id|length + 2) }}
+.. _{{ obj.id }}:
+.. py:function:: {{ obj.id }}({{ obj.args }}){% if obj.return_annotation is not none %} -> {{ obj.return_annotation }}{% endif %}
+
+{% for (args, return_annotation) in obj.overloads %}
+                 {{ obj.id }}({{ args }}){% if return_annotation is not none %} -> {{ return_annotation }}{% endif %}
+
+{% endfor %}
+   {% for property in obj.properties %}
+   :{{ property }}:
+   {% endfor %}
+
+   {% if obj.docstring %}
+   {{ obj.docstring|indent(3) }}
+
+   {% endif %}
+
+{% endif %}

docs/_autoapi_templates/python/method.rst

@@ -0,0 +1,24 @@
+{% if obj.display %}
+:py:meth:`{{ obj.id }} <{{ obj.id }}>`
+=========={{ "=" * 2 * (obj.id|length + 2) }}
+.. _{{ obj.id }}:
+.. py:method:: {{ obj.id }}({{ obj.args }}){% if obj.return_annotation is not none %} -> {{ obj.return_annotation }}{% endif %}
+
+{% for (args, return_annotation) in obj.overloads %}
+               {{ obj.id }}({{ args }}){% if return_annotation is not none %} -> {{ return_annotation }}{% endif %}
+
+{% endfor %}
+   {% if obj.properties %}
+   {% for property in obj.properties %}
+   :{{ property }}:
+   {% endfor %}
+
+   {% else %}
+
+   {% endif %}
+   {% if obj.docstring %}
+   {{ obj.docstring|indent(3) }}
+
+   {% endif %}
+
+{% endif %}

docs/_autoapi_templates/python/module.rst

@@ -0,0 +1,132 @@
+{% if not obj.display %}
+:orphan:
+
+{% endif %}
+:py:mod:`{{ obj.name }}`
+=========={{ "=" * obj.name|length }}
+
+.. py:module:: {{ obj.name }}
+
+{% if obj.docstring %}
+.. autoapi-nested-parse::
+
+   {{ obj.docstring|indent(3) }}
+
+{% endif %}
+
+{% block subpackages %}
+{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
+{% if visible_subpackages %}
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+{% for subpackage in visible_subpackages %}
+   {{ subpackage.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block submodules %}
+{% set visible_submodules = obj.submodules|selectattr("display")|list %}
+{% if visible_submodules %}
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+{% for submodule in visible_submodules %}
+   {{ submodule.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block content %}
+{% if obj.all is not none %}
+{% set visible_children = obj.children|selectattr("short_name", "in", obj.all)|list %}
+{% elif obj.type is equalto("package") %}
+{% set visible_children = obj.children|selectattr("display")|list %}
+{% else %}
+{% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %}
+{% endif %}
+{% if visible_children %}
+{{ obj.type|title }} Contents
+{{ "-" * obj.type|length }}---------
+
+{% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %}
+{% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %}
+{% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %}
+{% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %}
+{% block classes scoped %}
+{% if visible_classes %}
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+{% for klass in visible_classes %}
+   {{ klass.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block functions scoped %}
+{% if visible_functions %}
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+{% for function in visible_functions %}
+   {{ function.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block attributes scoped %}
+{% if visible_attributes %}
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+{% for attribute in visible_attributes %}
+   {{ attribute.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% if visible_classes %}
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+{% for klass in visible_classes %}
+   {{ klass.short_name }}<{{ klass.short_name }}/index>
+{% endfor %}
+{% endif %}
+
+{% if visible_functions %}
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+{% for function in visible_functions %}
+   {{ function.short_name }}<{{ function.short_name }}>
+{% endfor %}
+{% endif %}
+
+{% endif %}
+{% endif %}
+{% endblock %}

docs/_static/extra.css

@@ -0,0 +1,42 @@
+/* Set the colors for the light theme */
+[data-md-color-scheme="default"] {
+  --md-primary-fg-color: #344FA1;
+  --md-accent-fg-color: #4564C3;
+}
+
+/* Set the colors for the dark theme */
+[data-md-color-scheme="slate"] {
+  --md-primary-fg-color: #EAA915;
+  --md-accent-fg-color: #EEBA44;
+}
+[data-md-color-scheme="slate"] .md-header {
+  background-color: #344FA1;
+}
+[data-md-color-scheme="slate"] .md-tabs {
+  background-color: #344FA1;
+}
+
+/* Fix line numbers in code blocks */
+.linenos {
+  background-color: var(--md-default-bg-color--light);
+  margin-right: 0.5rem;
+}
+
+/* Override md-tab-set colors. */
+.md-typeset .tabbed-labels {
+  --md-accent-fg-color: var(--md-primary-fg-color);
+}
+
+/* Modify Sphinx Immaterial python-apigen linkable parameter coloring. */
+.sig-param a.reference span .pre {
+  color: var(--md-code-hl-generic-color);
+}
+.sig-param a.reference span .pre:hover {
+  color: var(--md-accent-fg-color);
+}
+
+/* Override announcement banner colors */
+.md-banner {
+  background-color: var(--md-typeset-mark-color);
+  color: var(--md-default-fg-color);
+}

docs/api/index.rst

@@ -0,0 +1,11 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   /api/iscan/index
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

docs/api/iscan/index.rst

@@ -0,0 +1,18 @@
+:py:mod:`iscan`
+===============
+
+.. py:module:: iscan
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   score_estimator/index.rst
+   shifted_edges/index.rst
+   shifted_nodes/index.rst
+   utils/index.rst
+
+

docs/api/iscan/score_estimator/index.rst

@@ -0,0 +1,27 @@
+:py:mod:`iscan.score_estimator`
+===============================
+
+.. py:module:: iscan.score_estimator
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   iscan.score_estimator.stein_hess
+
+
+
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   stein_hess<stein_hess>
+