Skip to content

Commit

Permalink
👷 [maykinmedia/open-api-framework#92] Make sure docs are built in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenbal committed Dec 20, 2024
1 parent 38807b9 commit 36c8cce
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,15 @@ jobs:
id: image-name

open-api-ci:
uses: maykinmedia/open-api-workflows/.github/workflows/ci.yml@v1
uses: maykinmedia/open-api-workflows/.github/workflows/ci.yml@v3.0.2
needs:
- store-reusable-workflow-vars
with:
main-branch: 'master'
run-docs: true
python-version: '3.11'
docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }}
django-settings-module: openklant.conf.ci

open-api-publish:
uses: maykinmedia/open-api-workflows/.github/workflows/publish.yml@v1
Expand Down
13 changes: 8 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,19 @@
"https://docs.python-requests.org/en/latest/",
None,
),
"django": (
"http://docs.djangoproject.com/en/3.2/",
"http://docs.djangoproject.com/en/3.2/_objects/",
),
# FIXME this is raising errors "not readable due to ValueError: I/O operation on closed file."
# "django": (
# "http://docs.djangoproject.com/en/4.2/",
# "http://docs.djangoproject.com/en/4.2/_objects/",
# ),
}

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_logo = "logo.svg"
# html_logo = "logo.svg"
html_theme = "sphinx_rtd_theme"

# Add any paths that contain custom static files (such as style sheets) here,
Expand All @@ -90,6 +91,8 @@

todo_include_todos = True

linkcheck_retries = 3

linkcheck_ignore = [
r"urn:*",
r"https?://.*\.gemeente.nl",
Expand Down

0 comments on commit 36c8cce

Please sign in to comment.