Merge pull request #344 from norlandrhagen/DFReferenceFileSystem_docs… #143
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
| name: Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| # Standard drop-in approach that should work for most people. | |
| - uses: ammaraskar/sphinx-action@master | |
| with: | |
| docs-folder: "docs/" | |
| # # Example of using a custom build-command. | |
| # - uses: ammaraskar/sphinx-action@master | |
| # with: | |
| # build-command: "sphinx-build -b html . _build" | |
| # docs-folder: "docs2/" | |
| # # Grabbing custom dependencies and building as a pdf. | |
| # - uses: ammaraskar/sphinx-action@master | |
| # with: | |
| # pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended" | |
| # build-command: "make latexpdf" | |
| # docs-folder: "docs2/" | |
| # # Great extra actions to compose with: | |
| # # Create an artifact of the html output. | |
| # - uses: actions/upload-artifact@v1 | |
| # with: | |
| # name: DocumentationHTML | |
| # path: docs/_build/html/ | |
| # # Create an artifact out of the previously built pdf. | |
| # - uses: actions/upload-artifact@v1 | |
| # with: | |
| # name: Documentation | |
| # path: docs2/_build/latex/pdfexample.pdf | |
| # Publish built docs to gh-pages branch. | |
| # =============================== | |
| - name: Commit documentation changes | |
| run: | | |
| git clone https://github.com/fsspec/kerchunk.git --branch gh-pages --single-branch gh-pages | |
| cp -r docs/build/html/* gh-pages/ | |
| cd gh-pages | |
| touch .nojekyll | |
| git config --local user.email "[email protected]" | |
| git config --local user.name "GitHub Action" | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| # The above command will fail if no changes were present, so we ignore | |
| # that. | |
| - name: Push changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # =============================== |