ammaraskar / sphinx-action

Github action that builds docs using sphinx and places errors inline
Apache License 2.0
194 stars 116 forks source link

Update Dockerfile #47

Open yamelsenih opened 2 years ago

yamelsenih commented 2 years ago

Just a minor change for update the sphinx base image to 5.0.2

We are using this change here

adam-grant-hendry commented 1 year ago

@yamelsenih Please do this. For sphinx<4, errors are occurring with deprecated jinja2 imports:

ImportError: cannot import name 'environmentfilter' from 'jinja2'

Updating sphinx in the Docker file should help resolve this. Feel free to reference my Issue #49 for this if you like.

+1

adam-grant-hendry commented 1 year ago

@ammaraskar Could we update the sphinx base image please?

watakandai commented 8 months ago

I found a workaround for now.

    - name: Build HTML
      uses: ammaraskar/sphinx-action@master
      with:
        pre-build-command: "pip install 'sphinx==7.1.2' --force-reinstall"
        docs-folder: "docs/"

This should upgrade the sphinx version.