diff --git a/.github/workflows/publish_documentation.yml b/.github/workflows/publish_documentation.yml new file mode 100644 index 00000000..7106427f --- /dev/null +++ b/.github/workflows/publish_documentation.yml @@ -0,0 +1,22 @@ +name: Publish docs via GitHub Pages +on: + push: + tags: + - "*" +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout main + uses: actions/checkout@v2 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CUSTOM_DOMAIN: biodatageeks.org + CONFIG_FILE: mkdocs.yml + EXTRA_PACKAGES: build-base + REQUIREMENTS: docs/requirements.txt \ No newline at end of file diff --git a/.github/workflows/publish_to_pypi.yml b/.github/workflows/publish_to_pypi.yml index 1e2dc9d1..34cdd910 100644 --- a/.github/workflows/publish_to_pypi.yml +++ b/.github/workflows/publish_to_pypi.yml @@ -7,9 +7,13 @@ on: - master tags: - '*' + paths-ignore: + - 'docs/**' + - 'benchmark/**' pull_request: workflow_dispatch: + concurrency: group: ${{ github.workflow }}-${{ github.ref }} diff --git a/mkdocs.yml b/mkdocs.yml index d211949e..0bfbd9e4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,8 @@ nav: - API reference: api.md plugins: + - search + - autorefs - mkdocs-jupyter: execute: true allow_errors: false @@ -15,21 +17,53 @@ plugins: options: docstring_style: google theme: - name: mkdocs + name: material features: - content.code.copy - content.code.select - content.code.annotate - + - content.tabs.link + - content.action.edit + - content.tooltips + - toc.follow + - navigation.top + - navigation.tabs + - navigation.tabs.sticky + - navigation.footer + - navigation.tracking + - navigation.instant + - content.footnote.tooltips extra: version: provider: mike markdown_extensions: + - admonition + - footnotes + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + - pymdownx.details - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite + - pymdownx.snippets: + base_path: .. + dedent_subsections: true + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - md_in_html + - abbr + - attr_list - pymdownx.snippets - - pymdownx.superfences \ No newline at end of file + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - markdown.extensions.toc: + baselevel: 1 + permalink: "" \ No newline at end of file