WIP: Making progress.

.gitignore

@@ -11,3 +11,6 @@ __pycache__/
 dist/
 build/
 src/caosdb/version.py
+
+# documentation
+_apidoc
\ No newline at end of file

Makefile

@@ -20,23 +20,14 @@
 # ** end header
 
 # This Makefile is a wrapper for several other scripts.
-#
-# It is based upon the autocreated 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     = src
-BUILDDIR      = build
+.PHONY: help
 
-.PHONY: doc-help Makefile
+help:
+	@echo 'Type `make doc` for documentation, or `make install` for (local) installation.'
 
-# Put it first so that "make" without argument is like "make help".
-doc-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+doc:
+	$(MAKE) -C src/doc html
 
-# 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)
+install:
+	@echo "Not implemented yet, use pip for installation."

src/caosdb/__init__.py

@@ -22,6 +22,9 @@
 # ** end header
 #
 
+"""CaosDB Python bindings
+"""
+
 from os import environ, getcwd
 # Import of the connection function (which is used to connect to the DB):
 from os.path import expanduser, join

src/caosdb/common/__init__.py

+"""Commonly used classes for CaosDB."""

src/doc/Makefile

+# ** header v3.0
+# This file is a part of the CaosDB Project.
+#
+# Copyright (C) 2020 IndiScale GmbH <info@indiscale.com>
+# Copyright (C) 2020 Daniel Hornung <d.hornung@indiscale.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+#
+# ** end header
+
+# This Makefile is a wrapper for sphinx scripts.
+#
+# It is based upon the autocreated 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
+SPHINXAPIDOC   ?= sphinx-apidoc
+SOURCEDIR     = .
+BUILDDIR      = ../../build/doc
+
+.PHONY: doc-help Makefile
+
+# Put it first so that "make" without argument is like "make help".
+doc-help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile apidoc
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+apidoc:
+	@$(SPHINXAPIDOC) -o _apidoc ../caosdb

src/conf.py → src/doc/conf.py

@@ -41,6 +41,7 @@ release = '0.x.y-beta-rc2'
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.napoleon',     # For Google style docstrings
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -181,3 +182,9 @@ epub_exclude_files = ['search.html']
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
+
+# TODO Which options do we want?
+autodoc_default_options = {
+    'members': None,
+    'undoc-members': None,
+}

src/index.rst → src/doc/index.rst

-.. caosdb-pylib documentation master file, created by
-   sphinx-quickstart on Wed Nov 18 17:40:20 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
 Welcome to caosdb-pylib's documentation!
 ========================================
@@ -10,9 +6,6 @@ Welcome to caosdb-pylib's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-.. automodule:: caosdb
-   :members:
-
 
 Indices and tables
 ==================