Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
16 changes: 16 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We just realised that this is publishing to GH pages 🙈
We'll fix this as part of #279

serve = "mike serve"
release = "version=$(python -W ignore -c 'import dagfactory; print(dagfactory.__version__)') && mike deploy --push --update-aliases $version latest"

######################################
# THIRD PARTY TOOLS
######################################
Expand Down