Skip to content
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
2 changes: 1 addition & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Contributors (chronological)
- Luna Lovegood `@duchuyvp <https://github.com/duchuyvp>`_
- Tobias Kolditz `@kolditz-senec <https://github.com/kolditz-senec>`_
- Christian Proud `@cjproud <https://github.com/cjproud>`_
- `<https://github.com/kolditz-senec >`_
- `<https://github.com/kolditz-senec>`_
- Theron Luhn `@luhn <https://github.com/luhn>`_
- Robert Shepley `@ShepleySound <https://github.com/ShepleySound>`_
- Robin `@allrob23 <https://github.com/allrob23>`_
Expand Down
3 changes: 0 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import importlib

import sphinx_rtd_theme

extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
Expand Down Expand Up @@ -33,4 +31,3 @@
# THEME

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ marshmallow = ["marshmallow>=3.18.0"]
docs = [
"apispec[marshmallow]",
"pyyaml==6.0.3",
"sphinx==8.2.3",
"sphinx==9.1.0",
"sphinx-issues==5.0.1",
"sphinx-rtd-theme==3.0.2",
"sphinx-rtd-theme==3.1.0rc2",
]
tests = ["apispec[yaml,marshmallow]", "openapi-spec-validator==0.7.2", "pytest"]
dev = ["apispec[tests]", "tox", "pre-commit>=3.5,<5.0"]
Expand Down
4 changes: 2 additions & 2 deletions src/apispec/ext/marshmallow/schema_resolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def __init__(self, openapi_version, converter):

def resolve_operations(self, operations, **kwargs):
"""Resolve marshmallow Schemas in a dict mapping operation to OpenApi `Operation Object
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject`_
<https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject>`_
"""

for operation in operations.values():
Expand All @@ -36,7 +36,7 @@ def resolve_operations(self, operations, **kwargs):

def resolve_callback(self, callbacks):
"""Resolve marshmallow Schemas in a dict mapping callback name to OpenApi `Callback Object
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#callbackObject`_.
<https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#callbackObject>`_.

This is done recursively, so it is possible to define callbacks in your callbacks.

Expand Down
8 changes: 5 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@ commands = sphinx-build docs/ docs/_build {posargs}

; Below tasks are for development only (not run in CI)

[testenv:watch-docs]
[testenv:docs-serve]
deps = sphinx-autobuild
extras = docs
commands = sphinx-autobuild --open-browser docs/ docs/_build {posargs} --watch src/apispec --delay 2
commands = sphinx-autobuild --port=0 --open-browser --delay=2 docs/ docs/_build {posargs} --watch src --watch CONTRIBUTING.rst --watch README.rst

[testenv:watch-readme]
[testenv:readme-serve]
deps = restview
skip_install = true
commands = restview README.rst