MCPcopy Create free account

hub / github.com/deceze/Sphinx-HTTP-domain / functions

Functions87 in github.com/deceze/Sphinx-HTTP-domain

↓ 8 callersMethodcontribute_to_app
(cls, app)
sphinx_http_domain/nodes.py:22
↓ 4 callersMethodastext
(self)
sphinx_http_domain/nodes.py:183
↓ 4 callersMethodset_first
(self)
sphinx_http_domain/nodes.py:15
↓ 2 callersMethodget_id
Returns cross-reference ID. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:48
↓ 2 callersFunctionslugify
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 callersMethodadd_index
Add index entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:88
↓ 1 callersMethodadd_target
Add cross-references to self.env.domaindata, if applicable.
sphinx_http_domain/directives.py:68
↓ 1 callersMethoddefault_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 callersMethodfind_xref
Returns a self.data entry for *target*, according to *typ*.
sphinx_http_domain/__init__.py:56
↓ 1 callersMethodget_anchor
Returns anchor for cross-reference IDs. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:32
↓ 1 callersMethodget_entry
Returns entry to add for cross-reference IDs. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:40
↓ 1 callersMethodnode_from_fragment
Returns a ``desc_http_fragment`` Node from a ``fragment`` string.
sphinx_http_domain/directives.py:199
↓ 1 callersMethodnode_from_method
Returns a ``desc_http_method`` Node from a ``method`` string.
sphinx_http_domain/directives.py:154
↓ 1 callersMethodnode_from_path
Returns a ``desc_http_path`` Node from a ``path`` string.
sphinx_http_domain/directives.py:176
↓ 1 callersMethodnode_from_query
Returns a ``desc_http_query`` Node from a ``query`` string.
sphinx_http_domain/directives.py:190
↓ 1 callersMethodnode_from_url
Returns a ``desc_http_url`` Node from a ``url`` string.
sphinx_http_domain/directives.py:160
↓ 1 callersFunctionsetup
(app)
sphinx_http_domain/__init__.py:117
↓ 1 callersFunctionslugify_url
Normalizes URL, converts to lowercase, removes non-URL characters, and converts non-alpha characters to hyphens.
sphinx_http_domain/utils.py:32
↓ 1 callersMethodsplit_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
Methodadd_index
Add index entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:248
Methodadd_index
Add index entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:300
Methodadd_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
Methodastext
(self)
sphinx_http_domain/nodes.py:58
Methodastext
(self, node)
sphinx_http_domain/nodes.py:131
Methodastext
(self)
sphinx_http_domain/nodes.py:266
Methodclear_doc
Remove traces of a document from self.data.
sphinx_http_domain/__init__.py:49
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:71
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:97
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:119
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:153
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:200
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:236
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:280
Methoddepart_html
(self, node)
sphinx_http_domain/nodes.py:311
Methoddepart_latex
(self, node)
sphinx_http_domain/nodes.py:44
Methoddepart_latex
(self, node)
sphinx_http_domain/nodes.py:80
Methoddepart_latex
(self, node)
sphinx_http_domain/nodes.py:106
Methoddepart_latex
(self, node)
sphinx_http_domain/nodes.py:164
Methoddepart_latex
(self, node)
sphinx_http_domain/nodes.py:248
Methoddepart_latex
(self, node)
sphinx_http_domain/nodes.py:289
Methoddepart_latex
(self, node)
sphinx_http_domain/nodes.py:319
Methoddepart_man
(self, node)
sphinx_http_domain/nodes.py:52
Methoddepart_man
(self, node)
sphinx_http_domain/nodes.py:85
Methoddepart_man
(self, node)
sphinx_http_domain/nodes.py:174
Methoddepart_man
(self, node)
sphinx_http_domain/nodes.py:258
Methoddepart_man
(self, node)
sphinx_http_domain/nodes.py:298
Methoddepart_man
(self, node)
sphinx_http_domain/nodes.py:327
Methoddepart_text
(self, node)
sphinx_http_domain/nodes.py:36
Methoddepart_text
(self, node)
sphinx_http_domain/nodes.py:62
Methoddepart_text
(self, node)
sphinx_http_domain/nodes.py:141
Methodget_entry
Returns entry to add for cross-reference IDs. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:231
Methodget_entry
(self, name, sig)
sphinx_http_domain/directives.py:297
Methodget_id
Returns cross-reference ID. *name* is whatever :meth:`handle_signature()` returned.
sphinx_http_domain/directives.py:240
Methodget_objects
Return an iterable of "object descriptions", which are tuples with five items: * `name` -- fully qualified name
sphinx_http_domain/__init__.py:92
Methodhandle_signature
Transform an HTTP method signature into RST nodes. Returns (method name, full URL).
sphinx_http_domain/directives.py:212
Methodhandle_signature
Transform an HTTP response into RST nodes. Returns the reference name.
sphinx_http_domain/directives.py:288
Methodmake_entry
(self, fieldarg, content)
sphinx_http_domain/docfields.py:114
Methodmake_field
(self, types, domain, items)
sphinx_http_domain/docfields.py:127
Methodresolve_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
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:66
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:92
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:114
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:145
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:192
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:229
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:274
Methodvisit_html
(self, node)
sphinx_http_domain/nodes.py:306
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:40
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:75
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:101
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:159
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:204
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:240
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:284
Methodvisit_latex
(self, node)
sphinx_http_domain/nodes.py:315
Methodvisit_man
(self, node)
sphinx_http_domain/nodes.py:48
Methodvisit_man
(self, node)
sphinx_http_domain/nodes.py:169
Methodvisit_man
(self, node)
sphinx_http_domain/nodes.py:209
Methodvisit_man
(self, node)
sphinx_http_domain/nodes.py:252
Methodvisit_man
(self, node)
sphinx_http_domain/nodes.py:293
Methodvisit_man
(self, node)
sphinx_http_domain/nodes.py:323
Methodvisit_text
(self, node)
sphinx_http_domain/nodes.py:32
Methodvisit_text
(self, node)
sphinx_http_domain/nodes.py:137
Methodvisit_text
(self, node)
sphinx_http_domain/nodes.py:187
Methodvisit_text
(self, node)
sphinx_http_domain/nodes.py:224
Methodvisit_text
(self, node)
sphinx_http_domain/nodes.py:270