Merge pull request #929 from stes/add-api-docs

Add API docs

Author: guzman-raphael

.nojekyll

@@ -110,6 +110,18 @@ important DataJoint schema or records.
 
 </details>
 
+### API docs
+
+The API documentation can be built using sphinx by running
+
+``` bash
+pip install sphinx sphinx_rtd_theme 
+(cd docs-api/sphinx && make html)
+```
+
+Generated docs are written to `docs-api/docs/html/index.html`.
+More details in [docs-api/README.md](docs-api/README.md).
+
 ## Running Tests Locally
 <details>
 <summary>Click to expand details</summary>

README.md

@@ -0,0 +1 @@
+docs/

docs-api/.gitignore

@@ -0,0 +1,20 @@
+# Datajoint API docs
+
+To generate the documentation, run
+
+``` bash
+(cd sphinx && make html)
+```
+
+Docs will be placed in the `docs/` folder.
+
+## Editing the docs
+
+All source files are in `sphinx/source`.
+Docs are currently structured as follows:
+
+```
+sphinx/source/conf.py         # Sphinx configuration file
+sphinx/source/index.rst       # This is the docs front page
+sphinx/source/datajoint.*.rst # Docs for different modules
+```

docs-api/README.md

@@ -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     = source
+BUILDDIR      = ../docs
+
+# 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-api/sphinx/Makefile

@@ -0,0 +1,60 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+import datajoint
+
+import sphinx_rtd_theme
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'DataJoint'
+copyright = '2021, datajoint.io'
+author = 'datajoint.io'
+
+# The full version, including alpha/beta/rc tags
+release = datajoint.__version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []

docs-api/sphinx/source/conf.py

@@ -0,0 +1,7 @@
+datajoint.admin module
+======================
+
+.. automodule:: datajoint.admin
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs-api/sphinx/source/datajoint.admin.rst

@@ -0,0 +1,7 @@
+datajoint.attribute\_adapter module
+===================================
+
+.. automodule:: datajoint.attribute_adapter
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs-api/sphinx/source/datajoint.attribute_adapter.rst

@@ -0,0 +1,7 @@
+datajoint.autopopulate module
+=============================
+
+.. automodule:: datajoint.autopopulate
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs-api/sphinx/source/datajoint.autopopulate.rst

@@ -0,0 +1,7 @@
+datajoint.blob module
+=====================
+
+.. automodule:: datajoint.blob
+   :members:
+   :undoc-members:
+   :show-inheritance: