tl;dr: We shouldn't be using the 'obj' roles from the Python domain.

The Python domain provides the 'obj' role as a generic, "catch all" way
to refer to any Python object of an unspecified type [1]. Unfortunately
we were erroneously making use of this role in two places.

The first of these is our doc fields [2], which we use to provide
information about request and response attributes, such as query
parameters (e.g. ':query foo:') or request parameters in the body (e.g.
':param bar:'). These are implemented using 'TypedField' because we want
to provide type information. For example:

  :query offset: offset number. default is 0
  :type offset: int

The 'TypedField' class allows you to specify a 'typerolename', which
determines the role that is automatically associated with a parameter
type with an object. For example, consider this example for the Python
domain:

  .. py:class:: User

     A user.

  .. py:function:: delete_user(user)

     Delete a user.

     :param user: The user to be deleted
     :type user: User
     :rtype: :class:`None`

Because the Python domain implements support for the 'param' doc field
using typerolename='class', the 'User' in ':type user: User' effectively
resolves to ':type user: :py:class:`User`' (*effectively* - there are
some differences). Since we don't provide an 'obj' role like the Python
domain does, we probably don't want to use this. We certainly don't want
to link to things in the Python domain, if that was even an option. As
such we simply drop the 'typerolename' attribute from our 'TypedField'
usages, thus disabling this "auto-linking" (which never would have
worked anyway).

The other place we're using the 'obj' role is in our definition of
'object_types' as part of the 'HTTPDomain' domain. This attribute is
supposed to list the type of objects that the domain will index - things
like classes and functions for the Python domain, or PUT and GET
requests for the HTTP domain. This is implemented by a mapping of types
to 'ObjType' instances, which in turn take the following arguments [3]:

  - *lname*: localized name of the type (do not include domain name)
  - *roles*: all the roles that can refer to an object of this type
  - *attrs*: object attributes -- currently only "searchprio" is known,
    which defines the object's priority in the full-text search index,
    see :meth:`Domain.get_objects()`.

We were passing two roles for each object type. The first of these
mapped to the name of a directive used to document said object, e.g. an
':options:' role to refer to an '.. option::' directive. The latter was
a generic ':obj:' role. This is clearly a hangover from the Python
directive, where, as noted previously, this would allow one to use the
':obj:' role to refer to *any* indexed Python object rather than using
object-specific roles like ':class:'. However, have no such generic role
defined for the HTTP domain and it probably wouldn't make sense to have
one. Therefore, we can and should simply drop this.

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-obj
[2] https://github.com/sphinx-doc/sphinx/blob/v4.1.2/sphinx/util/docfields.py#L1-L10
[3] https://github.com/sphinx-doc/sphinx/blob/v4.1.2/sphinx/domains/__init__.py#L40-L44



Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #53

Remove imports and calls to depracated function force_decode who was removed starting with sphinx 4.0 (#49)

Co-authored-by: Florian Masy <florian@ezdev.fr>

sphinxcontrib-httpdomain

[changelog skip]

[changelog skip]

Implement functionality necessary for http-domain to be usable in parallel and declare
sphinx extension as workable for parallel building

* Emit a warning in case of a duplicate entry-point definition

Co-authored-by: Daniel Hofmann <dani@k.j8l.de>
Co-authored-by: Ash Berlin-Taylor <ash_github@firemirror.com>

The old url is dead now, and this is causing test failures

[changelog skip]

[changelog skip]

[changelog skip]

Update links to use https

The http links produce warnings from linkcheck that they trigger
a redirection.

* Doc: fix the link to six

* A root slash for the url

Fix RST link syntax in the changelog

Fix bug #958064

See merge request !1

Martina Ferrari authored Apr 18, 2020 and Thomas Goirand committed Apr 18, 2020

The patch added in 1.5.0-1 had rendered the package unusable.
Closes: #958064.

Routingtable as label

also add a new changelog entry.

using the 'routingtable' label, ie. writing :ref:`routingtable` in rst docs.

Document the autoquickref option

Fix auto tornado support for tornado >= 4.5.

Fix changelog file location in .travis.yml

Implement autoquickref option