Use sphinx to build apidoc with doxygen

diff --git a/.gitignore b/.gitignore
index 678d282d8e1a1bf202a88607c721da1240b2c672..ac191757075f2b814323764e23137675089e11ef 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -80,6 +80,7 @@ galette/webroot/assets/*
 
 # API documentation
 apidocs/
+build/
 
 #Backup files
 *~

diff --git a/galette/docs/Makefile b/galette/docs/Makefile
new file mode 100644 (file)
index 0000000..ed88099
--- /dev/null
+++ b/galette/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/galette/docs/conf.py b/galette/docs/conf.py
new file mode 100644 (file)
index 0000000..42b6a57
--- /dev/null
+++ b/galette/docs/conf.py
@@ -0,0 +1,66 @@
+# 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 = 'Galette API'
+copyright = '2020, Johan Cwiklinski'
+author = 'Johan Cwiklinski'
+
+import subprocess
+subprocess.call('doxygen', shell=True)
+
+master_doc = 'index'
+
+# The full version, including alpha/beta/rc tags
+release = '0.9.4'
+
+
+# -- 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 = [
+#    'breathe'
+#]
+
+# Breathe Configuration
+#breathe_projects = { "galette": "./apidocs/xml/" }
+#breathe_default_project = "galette"
+
+# Add any paths that contain templates here, relative to this directory.
+#templates_path = ['source/_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 = ['apidocs/']
+html_extra_path = ['apidocs/html']
+
+
+# -- 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 = ['source/_static']

diff --git a/galette/docs/index.rst b/galette/docs/index.rst
new file mode 100644 (file)
index 0000000..4948429
--- /dev/null
+++ b/galette/docs/index.rst
@@ -0,0 +1 @@
+Empty file for doc generation

diff --git a/galette/docs/make.bat b/galette/docs/make.bat
new file mode 100644 (file)
index 0000000..9534b01
--- /dev/null
+++ b/galette/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+       set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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