[PATCH 1 of 2 yams] [doc] generate api doc using sphinx-apidoc

Laurent Peuch cortex at worlddomination.be
Wed Jan 8 11:21:19 CET 2020


# HG changeset patch
# User Laurent Peuch <cortex at worlddomination.be>
# Date 1578435329 -3600
#      Tue Jan 07 23:15:29 2020 +0100
# Node ID dfbc9d1516a96052ca63fa5d99c08dac8a04036d
# Parent  cdc742b5c26ffca0ddc08c8c62130e8039d7b793
# Available At https://hg.logilab.org/users/lpeuch/yams
#              hg pull https://hg.logilab.org/users/lpeuch/yams -r dfbc9d1516a9
[doc] generate api doc using sphinx-apidoc

diff --git a/doc/makefile b/doc/makefile
deleted file mode 100644
--- a/doc/makefile
+++ /dev/null
@@ -1,8 +0,0 @@
-all: apydoc
-
-apydoc:
-	epydoc --html -o apidoc -v --graph all --no-private --exclude="__pkginfo__" --exclude="setup" -n "Yams Module" ..
-
-clean:
-	rm -f *.html
-	rm -rf apidoc
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
--- /dev/null
+++ b/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)
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,56 @@
+# 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'yams'
+copyright = '2020, Logilab'
+author = 'Logilab'
+
+
+# -- 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.autodoc',
+]
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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 = 'alabaster'
+
+# 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 = ['_static']
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,23 @@
+.. yams documentation master file, created by
+   sphinx-quickstart on Tue Jan  7 16:34:28 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to yams's documentation!
+================================
+
+.. include:: ../README
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   yams
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+ at ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/yams.rst b/docs/yams.rst
new file mode 100644
--- /dev/null
+++ b/docs/yams.rst
@@ -0,0 +1,94 @@
+yams package
+============
+
+Submodules
+----------
+
+yams.buildobjs module
+---------------------
+
+.. automodule:: yams.buildobjs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.constraints module
+-----------------------
+
+.. automodule:: yams.constraints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.diff module
+----------------
+
+.. automodule:: yams.diff
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.interfaces module
+----------------------
+
+.. automodule:: yams.interfaces
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.reader module
+------------------
+
+.. automodule:: yams.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.schema module
+------------------
+
+.. automodule:: yams.schema
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.schema2dot module
+----------------------
+
+.. automodule:: yams.schema2dot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.serialize module
+---------------------
+
+.. automodule:: yams.serialize
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.tools module
+-----------------
+
+.. automodule:: yams.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+yams.xy module
+--------------
+
+.. automodule:: yams.xy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: yams
+   :members:
+   :undoc-members:
+   :show-inheritance:



More information about the cubicweb-devel mailing list