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.

Sign up for GitHub

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

Jump to bottom

Parameter type problem with newer sphinx (4.2.0) #55

Open
hofmandl1 opened this issue Sep 13, 2021 · 0 comments
Open

Parameter type problem with newer sphinx (4.2.0) #55

hofmandl1 opened this issue Sep 13, 2021 · 0 comments

Comments

@hofmandl1
Copy link
Contributor

hofmandl1 commented Sep 13, 2021 •
edited

I hit a problem in combination with newer sphinx (in my case 4.2.0):

This example was previously (3.5.4) working just fine:

.. http:get:: /test

   Some Text

   :query string sort: query parameter description

But with the newer Sphinx emits a warning (and thus breaks strict builds):

/home/hofmandl/sphinx-http/index.rst:5: WARNING: Problem in http domain: field is supposed to use role 'obj', but that role is not in the domain.

According to https://sphinxcontrib-httpdomain.readthedocs.io/en/stable/#resource-fields specifying a type is a perfectly valid usecase for the query-option.

When changing to :query sort: query parameter description the warning goes away.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hofmandl1