# ** header v3.0 # This file is a part of the CaosDB Project. # # Copyright (C) 2021 IndiScale GmbH <info@indiscale.com> # Copyright (C) 2021 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. # # Code documentation of the Octave code is created by `generate_doc` from # https://github.com/gnu-octave/generate_doc, Sphinx adds in additional documents. # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= -a SPHINXBUILD ?= sphinx-build OCTAVE ?= octave OCTAVEBUILDDIR = ./_build_octave 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 octavedoc @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) octavedoc: mkdir -p $(OCTAVEBUILDDIR) # pandoc ../CHANGELOG.md -o ../NEWS cp ../CHANGELOG.md ../NEWS @$(OCTAVE) Generate_Octave_Doc.m cp "_build_octave/caosdb/package_doc/Overview.html" "_build_octave/caosdb/overview.html"