Browse Source

Sphinx setup.

Stefano Cossu 6 years ago
parent
commit
9389677e46
6 changed files with 161 additions and 36 deletions
  1. 4 2
      docs/Makefile
  2. 14 30
      docs/api.rst
  3. 46 0
      docs/apidoc/lakesuperior.model.rst
  4. 85 0
      docs/apidoc/lakesuperior.rst
  5. 7 0
      docs/apidoc/modules.rst
  6. 5 4
      docs/conf.py

+ 4 - 2
docs/Makefile

@@ -3,7 +3,9 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+# Workaround to prevent lmdb from throwing an exception when loaded from Sphinx
+SPHINXBUILD   = python -m sphinx
+#SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = lakesuperior
 SOURCEDIR     = .
 BUILDDIR      = _build
@@ -17,4 +19,4 @@ help:
 # 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

+ 14 - 30
docs/api.rst

@@ -3,46 +3,30 @@ API Documentation
 
 .. module:: lakesuperior
 
-.. automodule:: lakesuperior.api.resource
-   :members:
-
-.. automodule:: lakesuperior.api.query
-   :members:
-
-.. automodule:: lakesuperior.api.admin
-   :members:
-
-
 Resource API
 ~~~~~~~~~~~~
 
-.. autoclass:: lakesuperior.model.ldpr.Ldpr
-   :members:
-   :inherited-members:
-
-.. autoclass:: lakesuperior.model.ldp_factory.LdpFactory
+.. automodule:: lakesuperior.api.resource
    :members:
-   :inherited-members:
-
-Low-Level API
-~~~~~~~~~~~~~
 
-Store Layout
-^^^^^^^^^^^^
+Query API
+~~~~~~~~~
 
-.. autoclass:: lakesuperior.store.ldp_rs.rsrc_centric_layout.RsrcCentricLayout
+.. automodule:: lakesuperior.api.query
    :members:
-   :inherited-members:
 
-.. autoclass:: lakesuperior.store.ldp_nr.base_non_rdf_layout.BaseNonRdfLayout
+Admin API
+~~~~~~~~~
+
+.. automodule:: lakesuperior.api.admin
    :members:
-   :inherited-members:
 
-RDF Store Abstraction
-^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: lakesuperior.store.ldp_rs.lmdb_store
-   :members:
-   :inherited-members:
+Full API docs
+~~~~~~~~~~~~~
 
+.. toctree::
+   :maxdepth: 3
+   :glob:
 
+   apidoc/*

+ 46 - 0
docs/apidoc/lakesuperior.model.rst

@@ -0,0 +1,46 @@
+lakesuperior\.model package
+===========================
+
+Submodules
+----------
+
+lakesuperior\.model\.ldp\_factory module
+----------------------------------------
+
+.. automodule:: lakesuperior.model.ldp_factory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.model\.ldp\_nr module
+-----------------------------------
+
+.. automodule:: lakesuperior.model.ldp_nr
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.model\.ldp\_rs module
+-----------------------------------
+
+.. automodule:: lakesuperior.model.ldp_rs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.model\.ldpr module
+--------------------------------
+
+.. automodule:: lakesuperior.model.ldpr
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: lakesuperior.model
+    :members:
+    :undoc-members:
+    :show-inheritance:

+ 85 - 0
docs/apidoc/lakesuperior.rst

@@ -0,0 +1,85 @@
+lakesuperior package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    lakesuperior.model
+
+Submodules
+----------
+
+lakesuperior\.app module
+------------------------
+
+.. automodule:: lakesuperior.app
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.config\_parser module
+-----------------------------------
+
+.. automodule:: lakesuperior.config_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.env module
+------------------------
+
+.. automodule:: lakesuperior.env
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.env\_setup module
+-------------------------------
+
+.. automodule:: lakesuperior.env_setup
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.exceptions module
+-------------------------------
+
+.. automodule:: lakesuperior.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.globals module
+----------------------------
+
+.. automodule:: lakesuperior.globals
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.migrator module
+-----------------------------
+
+.. automodule:: lakesuperior.migrator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lakesuperior\.toolbox module
+----------------------------
+
+.. automodule:: lakesuperior.toolbox
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: lakesuperior
+    :members:
+    :undoc-members:
+    :show-inheritance:

+ 7 - 0
docs/apidoc/modules.rst

@@ -0,0 +1,7 @@
+lakesuperior
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   lakesuperior

+ 5 - 4
docs/conf.py

@@ -17,10 +17,11 @@
 # 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 os
+import sys
+#sys.path.insert(0, os.path.abspath('../'))
+sys.path.append(os.path.abspath('../'))
+import lakesuperior.env_setup
 
 # -- General configuration ------------------------------------------------