Skip to content
Snippets Groups Projects
Commit ae8bad45 authored by Peter Lünenschloß's avatar Peter Lünenschloß
Browse files

some slimfast for the doc pipe

parent c55ecec2
No related branches found
No related tags found
7 merge requests!685Release 2.4,!684Release 2.4,!567Release 2.2.1,!566Release 2.2,!501Release 2.1,!372fix doctest snippets,!369Current documentation
Pipeline #25207 failed with stage
in 1 minute and 43 seconds
Showing
with 17 additions and 126 deletions
saqc
====
.. automodapi:: Functions.saqc
:no-heading:
......@@ -8,6 +8,8 @@ SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# sphinx build controll
FUNCTIONS = Functions
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
......@@ -16,32 +18,28 @@ help:
# clean sphinx generated stuff
clean:
rm -rf _build _static _api
rm -rf _build _static
rm -f *.automodsumm
rm -f func_modules/*.automodsumm
rm -f intro_modules/*.automodsumm
rm -rf ../docs
rm -rf ../$(FUNCTIONS)
mkdir _static
rm -r getting_started_md_m2r how_to_doc_md_m2r
# trigger (saqc) customized documentation pipeline
doc:
# generate fake modules to b documented by sphinx
python make_doc_module.py -p "saqc/funcs" -t "docs/intro_modules" -sr ".." -mo "intro_doc"
python make_doc_module.py -p "saqc/funcs" -t "docs/func_modules" -sr ".." -mo "registered_doc"
# make rest files from fake modules
python make_doc_rst.py -p "docs/intro_modules" -t "sphinx-doc/intro_modules" -sr ".."
python make_doc_rst.py -p "docs/func_modules" -t "sphinx-doc/func_modules" -sr ".."
# generate parent fake module for the functions to be documented
python make_doc_module.py -p "saqc/funcs" -t "$(FUNCTIONS)" -sr ".."
# make rest files from fake module
python make_doc_rst.py -p "$(FUNCTIONS)" -t "sphinx-doc/$(FUNCTIONS)" -sr ".."
# make rest folders from markdown folders
python make_md_to_rst.py -p "sphinx-doc/getting_started_md" -sr ".."
python make_md_to_rst.py -p "sphinx-doc/how_to_doc_md" -sr ".."
# make the html build
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# format docstring module domain strings to correct adresses
#python make_html_headings_proppa.py -b "sphinx-doc/_build/html/_api" -p "docs/func_modules" -sr ".."
#python make_html_headings_proppa.py -b "sphinx-doc/_build/html/_api" -p "docs/intro_modules" -sr ".."
# clear fake modules/intermediate rest files
rm -r getting_started_md_m2r
rm -r how_to_doc_md_m2r
#rm -r getting_started_md_m2r
#rm -r how_to_doc_md_m2r
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
......
Flags
=======
.. automodapi:: saqc.core.flags
:include-all-objects:
:no-heading:
breaks
======
.. automodapi:: docs.func_modules.breaks
:no-heading:
changepoints
============
.. automodapi:: docs.func_modules.changepoints
:no-heading:
constants
=========
.. automodapi:: docs.func_modules.constants
:no-heading:
curvefit
========
.. automodapi:: docs.func_modules.curvefit
:no-heading:
drift
=====
.. automodapi:: docs.func_modules.drift
:no-heading:
flagtools
=========
.. automodapi:: docs.func_modules.flagtools
:no-heading:
generic
=======
.. automodapi:: docs.func_modules.generic
:no-heading:
interpolation
=============
.. automodapi:: docs.func_modules.interpolation
:no-heading:
noise
=====
.. automodapi:: docs.func_modules.noise
:no-heading:
outliers
========
.. automodapi:: docs.func_modules.outliers
:no-heading:
pattern
=======
.. automodapi:: docs.func_modules.pattern
:no-heading:
resampling
==========
.. automodapi:: docs.func_modules.resampling
:no-heading:
residues
========
.. automodapi:: docs.func_modules.residues
:no-heading:
rolling
=======
.. automodapi:: docs.func_modules.rolling
:no-heading:
scores
======
.. automodapi:: docs.func_modules.scores
:no-heading:
tools
=====
.. automodapi:: docs.func_modules.tools
:no-heading:
transformation
==============
.. automodapi:: docs.func_modules.transformation
:no-heading:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment