https://github.com/goerz-docker/docs-build-env

Docker image for building Sphinx documentation.
https://github.com/goerz-docker/docs-build-env

Last synced: 14 days ago
JSON representation

Docker image for building Sphinx documentation.

• Host: GitHub
• URL: https://github.com/goerz-docker/docs-build-env
• Owner: goerz-docker
• Created: 2021-03-27T16:46:05.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-03-27T22:35:33.000Z (over 3 years ago)
• Last Synced: 2024-08-01T16:38:41.011Z (3 months ago)
• Language: Dockerfile
• Homepage:
• Size: 1000 Bytes
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docs-build-env Docker environment

Docker image for building Sphinx documentation.

## Usage

In a Github Actions workflow file, use this image as a job-level "container".

For example:

~~~

name: Docs

on: [push, ]

jobs:

  build_docs:

    name: Build Sphinx docs

    runs-on: ubuntu-18.04

    container:

      image: docker.pkg.github.com/goerz-testing/docs-build-env-docker/docs-build-env-docker:scientific

      credentials:

        username: ${{ github.repository_owner }}

        password: ${{ secrets.GITHUB_TOKEN }}

    steps:

      - uses: actions/checkout@v2

      - name: Build the docs

        run: |

          set -x

          python -m pip install -e .[dev]

          python -m sphinx -W "docs/sources/" -d "docs/_build/doctree" "docs/_build/html"

~~~