Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👷 [maykinmedia/open-api-framework#92] Make sure docs are built in CI #306

Merged
merged 4 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
4 changes: 2 additions & 2 deletions .github/workflows/code-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ name: "CodeQL"
on:
push:
branches:
- main
- master
pull_request:
# The branches below must be a subset of the branches above
branches:
- main
- master
schedule:
- cron: '0 23 * * 6'

Expand Down
8 changes: 5 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@
None,
),
"django": (
"http://docs.djangoproject.com/en/3.2/",
"http://docs.djangoproject.com/en/3.2/_objects/",
"http://docs.djangoproject.com/en/4.2/",
"http://docs.djangoproject.com/en/4.2/_objects/",
),
}

Expand All @@ -77,7 +77,7 @@
# 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 +90,8 @@

todo_include_todos = True

linkcheck_retries = 3

linkcheck_ignore = [
r"urn:*",
r"https?://.*\.gemeente.nl",
Expand Down
3 changes: 2 additions & 1 deletion docs/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,11 @@ Optional
* ``EMAIL_HOST_PASSWORD``: password to connect to the mail server. Defaults to: ``(empty string)``.
* ``EMAIL_USE_TLS``: whether to use TLS or not to connect to the mail server. Should be True if you're changing the ``EMAIL_PORT`` to 487. Defaults to: ``False``.
* ``DEFAULT_FROM_EMAIL``: The default email address from which emails are sent. Defaults to: ``[email protected]``.
* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``False``.
* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``True``.
* ``LOG_LEVEL``: control the verbosity of logging output. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``WARNING``.
* ``LOG_QUERIES``: enable (query) logging at the database backend level. Note that you must also set ``DEBUG=1``, which should be done very sparingly!. Defaults to: ``False``.
* ``LOG_REQUESTS``: enable logging of the outgoing requests. Defaults to: ``False``.
* ``CELERY_LOGLEVEL``: control the verbosity of logging output for celery, independent of ``LOG_LEVEL``. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``INFO``.
* ``SESSION_COOKIE_AGE``: For how long, in seconds, the session cookie will be valid. Defaults to: ``1209600``.
* ``SESSION_COOKIE_SAMESITE``: The value of the SameSite flag on the session cookie. This flag prevents the cookie from being sent in cross-site requests thus preventing CSRF attacks and making some methods of stealing session cookie impossible.Currently interferes with OIDC. Keep the value set at Lax if used. Defaults to: ``Lax``.
* ``CSRF_COOKIE_SAMESITE``: The value of the SameSite flag on the CSRF cookie. This flag prevents the cookie from being sent in cross-site requests. Defaults to: ``Strict``.
Expand Down
2 changes: 1 addition & 1 deletion requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ mozilla-django-oidc-db[setup-configuration]==0.21.1
# open-api-framework
notifications-api-common==0.3.1
# via commonground-api-common
open-api-framework==0.9.0
open-api-framework==0.9.1
# via -r requirements/base.in
orderedmultidict==1.0.1
# via furl
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci.txt
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ notifications-api-common==0.3.1
# via
# -r requirements/base.txt
# commonground-api-common
open-api-framework==0.9.0
open-api-framework==0.9.1
# via -r requirements/base.txt
orderedmultidict==1.0.1
# via
Expand Down
2 changes: 1 addition & 1 deletion requirements/dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ notifications-api-common==0.3.1
# via
# -r requirements/base.txt
# commonground-api-common
open-api-framework==0.9.0
open-api-framework==0.9.1
# via -r requirements/base.txt
orderedmultidict==1.0.1
# via
Expand Down
Loading