Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/deceze/Sphinx-HTTP-domain
/ functions
Functions
87 in github.com/deceze/Sphinx-HTTP-domain
⨍
Functions
87
◇
Types & classes
15
↓ 8 callers
Method
contribute_to_app
(cls, app)
sphinx_http_domain/nodes.py:22
↓ 4 callers
Method
astext
(self)
sphinx_http_domain/nodes.py:183
↓ 4 callers
Method
set_first
(self)
sphinx_http_domain/nodes.py:15
↓ 2 callers
Method
get_id
Returns cross-reference ID. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:48
↓ 2 callers
Function
slugify
Normalizes string, converts to lowercase, removes non-alpha characters, and converts spaces to hyphens. From Django's "django/template/d
sphinx_http_domain/utils.py:18
↓ 1 callers
Method
add_index
Add index entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:88
↓ 1 callers
Method
add_target
Add cross-references to self.env.domaindata, if applicable.
sphinx_http_domain/directives.py:68
↓ 1 callers
Method
default_content
Given a fieldarg, returns the status code description in list form. The default status codes are provided in self.status_codes.
sphinx_http_domain/docfields.py:103
↓ 1 callers
Method
find_xref
Returns a self.data entry for *target*, according to *typ*.
sphinx_http_domain/__init__.py:56
↓ 1 callers
Method
get_anchor
Returns anchor for cross-reference IDs. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:32
↓ 1 callers
Method
get_entry
Returns entry to add for cross-reference IDs. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:40
↓ 1 callers
Method
node_from_fragment
Returns a ``desc_http_fragment`` Node from a ``fragment`` string.
sphinx_http_domain/directives.py:199
↓ 1 callers
Method
node_from_method
Returns a ``desc_http_method`` Node from a ``method`` string.
sphinx_http_domain/directives.py:154
↓ 1 callers
Method
node_from_path
Returns a ``desc_http_path`` Node from a ``path`` string.
sphinx_http_domain/directives.py:176
↓ 1 callers
Method
node_from_query
Returns a ``desc_http_query`` Node from a ``query`` string.
sphinx_http_domain/directives.py:190
↓ 1 callers
Method
node_from_url
Returns a ``desc_http_url`` Node from a ``url`` string.
sphinx_http_domain/directives.py:160
↓ 1 callers
Function
setup
(app)
sphinx_http_domain/__init__.py:117
↓ 1 callers
Function
slugify_url
Normalizes URL, converts to lowercase, removes non-URL characters, and converts non-alpha characters to hyphens.
sphinx_http_domain/utils.py:32
↓ 1 callers
Method
split_url
Splits a ``url`` string into its components. Returns (path, query string, fragment).
sphinx_http_domain/directives.py:204
Method
__init__
(self, *args, **kwargs)
sphinx_http_domain/docfields.py:123
Method
add_index
Add index entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:248
Method
add_index
Add index entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:300
Method
add_target_and_index
Add cross-reference IDs and entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:56
Method
astext
(self)
sphinx_http_domain/nodes.py:58
Method
astext
(self, node)
sphinx_http_domain/nodes.py:131
Method
astext
(self)
sphinx_http_domain/nodes.py:266
Method
clear_doc
Remove traces of a document from self.data.
sphinx_http_domain/__init__.py:49
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:71
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:97
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:119
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:153
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:200
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:236
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:280
Method
depart_html
(self, node)
sphinx_http_domain/nodes.py:311
Method
depart_latex
(self, node)
sphinx_http_domain/nodes.py:44
Method
depart_latex
(self, node)
sphinx_http_domain/nodes.py:80
Method
depart_latex
(self, node)
sphinx_http_domain/nodes.py:106
Method
depart_latex
(self, node)
sphinx_http_domain/nodes.py:164
Method
depart_latex
(self, node)
sphinx_http_domain/nodes.py:248
Method
depart_latex
(self, node)
sphinx_http_domain/nodes.py:289
Method
depart_latex
(self, node)
sphinx_http_domain/nodes.py:319
Method
depart_man
(self, node)
sphinx_http_domain/nodes.py:52
Method
depart_man
(self, node)
sphinx_http_domain/nodes.py:85
Method
depart_man
(self, node)
sphinx_http_domain/nodes.py:174
Method
depart_man
(self, node)
sphinx_http_domain/nodes.py:258
Method
depart_man
(self, node)
sphinx_http_domain/nodes.py:298
Method
depart_man
(self, node)
sphinx_http_domain/nodes.py:327
Method
depart_text
(self, node)
sphinx_http_domain/nodes.py:36
Method
depart_text
(self, node)
sphinx_http_domain/nodes.py:62
Method
depart_text
(self, node)
sphinx_http_domain/nodes.py:141
Method
get_entry
Returns entry to add for cross-reference IDs. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:231
Method
get_entry
(self, name, sig)
sphinx_http_domain/directives.py:297
Method
get_id
Returns cross-reference ID. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:240
Method
get_objects
Return an iterable of "object descriptions", which are tuples with five items: * `name` -- fully qualified name
sphinx_http_domain/__init__.py:92
Method
handle_signature
Transform an HTTP method signature into RST nodes. Returns (method name, full URL).
sphinx_http_domain/directives.py:212
Method
handle_signature
Transform an HTTP response into RST nodes. Returns the reference name.
sphinx_http_domain/directives.py:288
Method
make_entry
(self, fieldarg, content)
sphinx_http_domain/docfields.py:114
Method
make_field
(self, types, domain, items)
sphinx_http_domain/docfields.py:127
Method
resolve_xref
Resolve the ``pending_xref`` *node* with the given *typ* and *target*. Returns a new reference node, to replace the xref node.
sphinx_http_domain/__init__.py:63
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:66
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:92
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:114
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:145
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:192
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:229
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:274
Method
visit_html
(self, node)
sphinx_http_domain/nodes.py:306
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:40
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:75
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:101
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:159
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:204
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:240
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:284
Method
visit_latex
(self, node)
sphinx_http_domain/nodes.py:315
Method
visit_man
(self, node)
sphinx_http_domain/nodes.py:48
Method
visit_man
(self, node)
sphinx_http_domain/nodes.py:169
Method
visit_man
(self, node)
sphinx_http_domain/nodes.py:209
Method
visit_man
(self, node)
sphinx_http_domain/nodes.py:252
Method
visit_man
(self, node)
sphinx_http_domain/nodes.py:293
Method
visit_man
(self, node)
sphinx_http_domain/nodes.py:323
Method
visit_text
(self, node)
sphinx_http_domain/nodes.py:32
Method
visit_text
(self, node)
sphinx_http_domain/nodes.py:137
Method
visit_text
(self, node)
sphinx_http_domain/nodes.py:187
Method
visit_text
(self, node)
sphinx_http_domain/nodes.py:224
Method
visit_text
(self, node)
sphinx_http_domain/nodes.py:270