Skip to content

Commit

Permalink
refs #147: Added a test workflow to deploy docs site via GH Actions. …
Browse files Browse the repository at this point in the history
…This is a test commit.
  • Loading branch information
stickgrinder committed Mar 17, 2024
1 parent 1befb7e commit 6df1667
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 4 deletions.
75 changes: 75 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Publish updated documentation

# on:
# push:
# tags:
# - "v*.*.*"
# - "v*.*.*-alpha*"
# - "v*.*.*-beta*"
# - "v*.*.*-rc*"

on:
push:
branches:
- feature/147-docs-release-automation

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.11
- run: >
pip install
mkdocs==1.5.3
mkdocs-nav-weight
mkdocs-abs-rel-plugin
mkdocs-add-number-plugin
mkdocs-autolinks-plugin
mkdocs-autorefs
mkdocs-awesome-pages-plugin
mkdocs-codeinclude-plugin
mkdocs-enumerate-headings-plugin
mkdocs-exclude
mkdocs-exclude-search
mkdocs-gallery
mkdocs-gen-files
mkdocs-git-authors-plugin
mkdocs-git-committers-plugin-2
mkdocs-git-revision-date-localized-plugin
mkdocs-img2fig-plugin
mkdocs-include-markdown-plugin
mkdocs-kroki-plugin
mkdocs-literate-nav
mkdocs-localsearch
mkdocs-macros-plugin
mkdocs-markdownextradata-plugin
mkdocs-merge
mkdocs-minify-plugin
mkdocs-monorepo-plugin
mkdocs-multirepo
mkdocs-multirepo-plugin
mkdocs-no-sitemap-plugin
mkdocs-print-site-plugin
mkdocs_pymdownx_material_extras
mkdocs-safe-text-plugin
mkdocs-same-dir
mkdocs-section-index
mkdocs-simple-hooks
mkdocs-simple-plugin
mkdocs-swagger-ui-tag
mkdocs-redirects
mkdocs-versioning
mkdocs-with-confluence
mkdocstrings
mkdocs-alabaster
mkdocs-cinder
mkdocs-kpn
mkdocs-material
neoteroi-mkdocs
markdown-include
pygments
pymdown-extensions
- run: mkdocs gh-deploy --force --clean --verbose
5 changes: 2 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
name: Release new version

permissions:
contents: write

on:
push:
tags:
Expand All @@ -14,6 +11,8 @@ on:
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v3
Expand Down
2 changes: 1 addition & 1 deletion docs/src/the-editor-handbook/editor-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
weight: 2010
---

TODO: how to reach the editor settings and set them up
TODO: how to reach the editor settings and set them up.

0 comments on commit 6df1667

Please sign in to comment.