-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: merging mkdocs with current static pages (#104)
- Loading branch information
1 parent
a2dc9ee
commit f0ec748
Showing
9 changed files
with
68 additions
and
137 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# You need to enable github to host your pages. | ||
# github.com > Settings > Pages > Build and deployment: | ||
# > Source > Deploy from a branches | ||
# > Branch > gh-pages / `/root` | ||
name: Deploy docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
- main | ||
paths: | ||
- "**.md" | ||
- "mkdocs.yml" | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: write | ||
|
||
concurrency: | ||
group: ${{ github.workflow }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup doc deploy | ||
run: | | ||
git config user.name 'github-actions[bot]' | ||
git config user.email 'github-actions[bot]@users.noreply.github.com' | ||
- name: Deploy docs | ||
uses: mhausenblas/mkdocs-deploy-gh-pages@master | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
REQUIREMENTS: docs/requirements.txt |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
site/ |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# [mkdocs](https://github.com/mkdocs/mkdocs): | ||
# Project documentation with Markdown. | ||
mkdocs>=1.5.2 | ||
|
||
# [mkdocs-click](https://github.com/mkdocs/mkdocs-click): | ||
# An MkDocs extension to generate documentation for Click command line applications. | ||
#mkdocs-click>=0.8.0 | ||
|
||
# [mkdocs-typer](https://github.com/bruce-szalwinski/mkdocs-typer): | ||
# An MkDocs extension to generate documentation for Typer command line applications. | ||
#mkdocs-typer>=0.0.3 | ||
|
||
# [mkdocs-material](https://github.com/squidfunk/mkdocs-material): | ||
# Documentation that simply works. | ||
mkdocs-material>=9.2.5 | ||
|
||
# [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings): | ||
# 📘 Automatic documentation from sources, for MkDocs. | ||
#mkdocstrings[python]>=0.22.0 | ||
|
||
# [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin): | ||
# Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code. | ||
#mkdocs-macros-plugin>=1.0.4 | ||
|
||
# [mike](Manage multiple versions of your MkDocs-powered documentation via Git): | ||
# Manage multiple versions of your MkDocs-powered documentation via Git | ||
#mike>=1.1.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.