Skip to content

Commit

Permalink
feat: merging mkdocs with current static pages (#104)
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelLarkin authored Oct 23, 2024
1 parent a2dc9ee commit f0ec748
Show file tree
Hide file tree
Showing 9 changed files with 68 additions and 137 deletions.
30 changes: 0 additions & 30 deletions .github/workflows/ci.yaml

This file was deleted.

43 changes: 0 additions & 43 deletions .github/workflows/doc.yaml

This file was deleted.

38 changes: 38 additions & 0 deletions .github/workflows/docs.yaml
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
43 changes: 0 additions & 43 deletions .github/workflows/static.yml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site/
File renamed without changes.
27 changes: 27 additions & 0 deletions docs/requirements.txt
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
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ nav:
- Home: index.md
- Trixie Status: Trixie-Status.md
- Account Codes: Account-Codes.md
- Presentations:
- Be a Good Cluster Citizen: BeAGoodClusterCitizen.html
- General Info:
- Available Software: Available-Software.md
- Hardware: Hardware.md
Expand Down
21 changes: 0 additions & 21 deletions static/index.html

This file was deleted.

0 comments on commit f0ec748

Please sign in to comment.