Docs Update (#267) #235
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
| # Author: Jordan Dennis | |
| # Date: 07/07/2022 | |
| # Title: documentation.yml | |
| # Description: Automatically generates the docs on a merge. | |
| name: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| documentation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: checkout all | |
| uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: 0 | |
| - name: python install | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.x | |
| architecture: x64 | |
| - name: install environment | |
| run: | | |
| pip install mkdocs | |
| pip install mkdocs-jupyter | |
| pip install mkdocs-same-dir | |
| pip install pymdown-extensions | |
| pip install mkdocs-pymdownx-material-extras | |
| pip install mkdocs-autorefs | |
| pip install mkdocs-simple-plugin | |
| pip install mkdocstrings | |
| pip install mkdocstrings[python] | |
| pip install mkdocs-material | |
| pip install --upgrade notebook==6.4.12 | |
| - name: generate and deploy documentation | |
| run: mkdocs gh-deploy -d https://louisdesdoigts.github.io/dLux | |