diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..52fd0843 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,30 @@ + +name: Docs + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request + push: + branches: [ dev, docs ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: actions/setup-python@v4 + + - run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files + - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com' + + - name: Publish docs + run: mkdocs gh-deploy \ No newline at end of file diff --git a/Documentation/index.md b/Documentation/index.md new file mode 100644 index 00000000..e69de29b diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..520ddc26 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,14 @@ +site_name: IronOS +site_url: https://ralim.github.io/IronOS/ +repo_url: https://github.com/ralim/IronOS/ +site_description: "IronOS Open Source Soldering Iron firmware for Miniware and Pinecil" +docs_dir: Documentation +nav: + - Home: index.md + - Getting Started: GettingStarted.md + - Troubleshooting: + - Troubleshooting: Troubleshooting.md + - Known Hardware Issues: HardwareIssues.md + + +theme: readthedocs \ No newline at end of file