diff --git a/modules/ml-pipeline/.pre-commit-config.yaml b/modules/ml-pipeline/.pre-commit-config.yaml index 55ad383..79ed459 100644 --- a/modules/ml-pipeline/.pre-commit-config.yaml +++ b/modules/ml-pipeline/.pre-commit-config.yaml @@ -1,5 +1,11 @@ # Pre commit hooks repos: +# - repo: local +# hooks: +# - id: build-sphinx-docs +# name: Build Sphinx Documentation +# entry: bash -c 'cd modules/ml-pipeline/docs && make html' +# language: system - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.3.0 hooks: @@ -14,6 +20,6 @@ repos: hooks: - id: dvc-push-experiment name: DVC - Push to experiment to remote location (experiments) - entry: bash -c 'cd modules/ml-pipeline/src/pipeline/src && dvc push' + entry: bash -c 'cd modules/ml-pipeline/src/pipeline/src && dvc push -r experiments || echo "Up to date!"' language: system verbose: true diff --git a/modules/ml-pipeline/docs/Makefile b/modules/ml-pipeline/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/modules/ml-pipeline/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/modules/ml-pipeline/docs/README.md b/modules/ml-pipeline/docs/README.md deleted file mode 100644 index cde8373..0000000 --- a/modules/ml-pipeline/docs/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Docs generation - -This will be done via a sphinx pre-commit hook -Only file to adjust is probably the conf.py file if needed diff --git a/modules/ml-pipeline/docs/_build/doctrees/environment.pickle b/modules/ml-pipeline/docs/_build/doctrees/environment.pickle new file mode 100644 index 0000000..78bd6e1 Binary files /dev/null and b/modules/ml-pipeline/docs/_build/doctrees/environment.pickle differ diff --git a/modules/ml-pipeline/docs/_build/doctrees/index.doctree b/modules/ml-pipeline/docs/_build/doctrees/index.doctree new file mode 100644 index 0000000..f4a9eb6 Binary files /dev/null and b/modules/ml-pipeline/docs/_build/doctrees/index.doctree differ diff --git a/modules/ml-pipeline/docs/_build/doctrees/modules.doctree b/modules/ml-pipeline/docs/_build/doctrees/modules.doctree new file mode 100644 index 0000000..4a22a44 Binary files /dev/null and b/modules/ml-pipeline/docs/_build/doctrees/modules.doctree differ diff --git a/modules/ml-pipeline/docs/_build/doctrees/src.core.doctree b/modules/ml-pipeline/docs/_build/doctrees/src.core.doctree new file mode 100644 index 0000000..6292384 Binary files /dev/null and b/modules/ml-pipeline/docs/_build/doctrees/src.core.doctree differ diff --git a/modules/ml-pipeline/docs/_build/doctrees/src.core.interface.doctree b/modules/ml-pipeline/docs/_build/doctrees/src.core.interface.doctree new file mode 100644 index 0000000..a2002dc Binary files /dev/null and b/modules/ml-pipeline/docs/_build/doctrees/src.core.interface.doctree differ diff --git a/modules/ml-pipeline/docs/_build/doctrees/src.doctree b/modules/ml-pipeline/docs/_build/doctrees/src.doctree new file mode 100644 index 0000000..ccc072e Binary files /dev/null and b/modules/ml-pipeline/docs/_build/doctrees/src.doctree differ diff --git a/modules/ml-pipeline/docs/_build/html/.buildinfo b/modules/ml-pipeline/docs/_build/html/.buildinfo new file mode 100644 index 0000000..2410301 --- /dev/null +++ b/modules/ml-pipeline/docs/_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 3f3ff68ecd6e013aca173ae96ddcdaf6 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/modules/ml-pipeline/docs/_build/html/_modules/index.html b/modules/ml-pipeline/docs/_build/html/_modules/index.html new file mode 100644 index 0000000..17621a0 --- /dev/null +++ b/modules/ml-pipeline/docs/_build/html/_modules/index.html @@ -0,0 +1,101 @@ + + +
+ + +
+"""
+Logger that will be used throughout the application
+"""
+
+import logging
+
+
+
+[docs]
+def setup_logger():
+ # Create a logger
+ logger = logging.getLogger()
+
+ # Set the log level
+ logger.setLevel(logging.INFO)
+
+ # Create a formatter
+ formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
+
+ # Create a stream handler to direct logs to stdout
+ stream_handler = logging.StreamHandler()
+ stream_handler.setFormatter(formatter)
+
+ # Add the stream handler to the logger
+ logger.addHandler(stream_handler)
+
+ return logger
+
+
+
+logger = setup_logger()
+' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/modules/ml-pipeline/docs/_build/html/genindex.html b/modules/ml-pipeline/docs/_build/html/genindex.html new file mode 100644 index 0000000..0910426 --- /dev/null +++ b/modules/ml-pipeline/docs/_build/html/genindex.html @@ -0,0 +1,164 @@ + + + + + +
|
+
|
+ + |
Contents:
+| + s | ||
| + |
+ src | + |
| + |
+ src.core | + |
| + |
+ src.core.interface | + |
| + |
+ src.core.Logger | + |