diff --git a/docs-requirements.txt b/docs-requirements.txt new file mode 100644 index 0000000..6b4f1d5 --- /dev/null +++ b/docs-requirements.txt @@ -0,0 +1,3 @@ +myst_parser==0.17.2 +Sphinx>=4.5.0 +m2r2==0.3.2 diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /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/_static/dbt-logo.png b/docs/_static/dbt-logo.png new file mode 100644 index 0000000..de45f34 Binary files /dev/null and b/docs/_static/dbt-logo.png differ diff --git a/docs/_static/mara-logo.jpg b/docs/_static/mara-logo.jpg new file mode 100644 index 0000000..89254ef Binary files /dev/null and b/docs/_static/mara-logo.jpg differ diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..6336d76 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1 @@ +.. mdinclude:: ../CHANGELOG.md diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..ff81dd7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,59 @@ +# 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 = 'Mara dbt' +copyright = '2021-2022, Mara contributors' +author = 'Mara contributors' + + +# -- 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 = [ + 'm2r2',#'myst_parser', + +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +#source_suffix = ['.rst', '.md'] + +# 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'] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..ce9f733 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,32 @@ +.. Mara dbt documentation master file, created by + sphinx-quickstart on Sat May 21 13:33:52 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Mara dbt Extension! +============================== + +.. image:: _static/mara-logo.jpg + :align: left + :width: 40% + +.. image:: _static/dbt-logo.png + :align: right + :width: 40% + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Contents: + + readme + changelog + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..97d4958 --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1 @@ +.. mdinclude:: ../README.md diff --git a/setup.cfg b/setup.cfg index 3be7385..9be5903 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,7 +2,7 @@ name = mara-dbt version = attr: mara_dbt.__version__ url = https://github.com/mara/mara-dbt -description = dbt integration into the mara framework +description = dbt integration into the Mara Framework long_description = file: README.md long_description_content_type = text/markdown author = Mara contributors