diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..805775d3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,19 @@ +site_name: DAG Factory Documentation +extra: + version: + provider: mike + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets: + check_paths: true + base_path: [ "." ] + - pymdownx.superfences + +plugins: + - mike: + alias_type: symlink diff --git a/pyproject.toml b/pyproject.toml index cd5b87fc..f9bab9c4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -101,6 +101,22 @@ filterwarnings = ["ignore::DeprecationWarning"] minversion = "6.0" markers = ["integration", "callbacks"] +###################################### +# DOCS +###################################### + +[tool.hatch.envs.docs] +dependencies = [ + "mkdocs", + "mike", + "pymdown-extensions", +] + +[tool.hatch.envs.docs.scripts] +build = "mike deploy --push dev" +serve = "mike serve" +release = "version=$(python -W ignore -c 'import dagfactory; print(dagfactory.__version__)') && mike deploy --push --update-aliases $version latest" + ###################################### # THIRD PARTY TOOLS ######################################