Skip to content

Commit

Permalink
enh: Build documentation in root dir
Browse files Browse the repository at this point in the history
  • Loading branch information
TEParsons committed May 26, 2024
1 parent 12a587e commit 983d6f9
Show file tree
Hide file tree
Showing 14 changed files with 41 additions and 193 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Publish docs

on: push

jobs:
build:
name: Build docs
runs-on: macos-11

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.10"

- name: Install dependencies
run: |
python3 -m pip install mkdocs mkdocs-torillic
- name: Build docs
run: |
mkdocs build
- name: Commit
run: |
git add --all
git commit --all -m "sys: Build documentation"
- name: Push
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
force: true
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@ sphinx/example/stderr.txt
mkdocs/example/site

scratch.*
*.code-workspace
*.code-workspace

.export
3 changes: 0 additions & 3 deletions docs/dist.stub

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
4 changes: 1 addition & 3 deletions docs/mkdocs.yaml → mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ theme:
features:
- navigation.pathnavigation
site_name: Torillic
docs_dir: src
docs_dir: docs_src
site_dir: docs
nav:
- Home: index.md
- Example Statblocks: examples.md
exclude_docs: |
desktop.ini
markdown_extensions:
- nl2br
1 change: 0 additions & 1 deletion utils/__init__.py

This file was deleted.

37 changes: 0 additions & 37 deletions utils/build.py

This file was deleted.

60 changes: 0 additions & 60 deletions utils/export.py

This file was deleted.

24 changes: 0 additions & 24 deletions utils/publish.py

This file was deleted.

64 changes: 0 additions & 64 deletions utils/version.py

This file was deleted.

Empty file removed version
Empty file.

0 comments on commit 983d6f9

Please sign in to comment.