module sphinxext.sphinx_ext_helper
¶
Classes¶
class |
truncated documentation |
---|---|
Returned by function |
|
Returned by function |
|
Returned by |
|
Wraps a docutils node. |
Functions¶
function |
truncated documentation |
---|---|
Loads file |
|
Retrieves documentation data for a specific module. |
|
Log information with Sphinx. |
|
Returns the language defined in the configuration file. |
|
Enumerates through all children but insert a node whenever digging or leaving the childrens nodes. |
Methods¶
method |
truncated documentation |
---|---|
|
Create a note |
|
Create a note |
Create a note |
|
Documentation¶
Few helpers for Sphinx.
-
class
pyquickhelper.sphinxext.sphinx_ext_helper.
NodeEnter
(parent)[source][source]¶ Bases:
pyquickhelper.sphinxext.sphinx_ext_helper.TinyNode
Returned by function
traverse
.Create a note
- Parameters
parent – parent node
-
class
pyquickhelper.sphinxext.sphinx_ext_helper.
NodeLeave
(parent)[source][source]¶ Bases:
pyquickhelper.sphinxext.sphinx_ext_helper.TinyNode
Returned by function
traverse
.Create a note
- Parameters
parent – parent node
-
class
pyquickhelper.sphinxext.sphinx_ext_helper.
TinyNode
(parent)[source][source]¶ Bases:
object
Returned by
traverse
.Create a note
- Parameters
parent – parent node
-
class
pyquickhelper.sphinxext.sphinx_ext_helper.
WrappedNode
(node)[source][source]¶ Bases:
object
Wraps a docutils node.
-
pyquickhelper.sphinxext.sphinx_ext_helper.
_get_data
(url)[source][source]¶ Loads file
objects.inv
generated by extension sphinx.ext.intersphinx.- Parameters
url – url of documentation, example
https://pandas.pydata.org/docs/
- Returns
instance of InventoryFile
-
pyquickhelper.sphinxext.sphinx_ext_helper.
get_index
(index_url, cache_dir)[source][source]¶ Retrieves documentation data for a specific module.
- Parameters
url – url of documentation, example
https://pandas.pydata.org/docs/
cache_dir – restore a cached inventory stored with pickle
- Returns
instance of InventoryFile
-
pyquickhelper.sphinxext.sphinx_ext_helper.
info_blocref
(app, doctree, fromdocname, class_name, entry_name, class_node, class_node_list)[source][source]¶ Log information with Sphinx.
- Parameters
app – application (Sphinx)
doctree – document tree
fromdocname – document currently being compiled
class_name – name of the node
entry_name – entry name in
TITLES
class_node – class node (
blocref_node
)class_node_list – class node list (
blocreflist
)
-
pyquickhelper.sphinxext.sphinx_ext_helper.
sphinx_lang
(env, default_value='en')[source][source]¶ Returns the language defined in the configuration file.
- Parameters
env – environment
default_value – default value
- Returns
language
-
pyquickhelper.sphinxext.sphinx_ext_helper.
traverse
(node, depth=0)[source][source]¶ Enumerates through all children but insert a node whenever digging or leaving the childrens nodes.
- Parameters
node – node (from doctree)
depth – current depth
- Returns
enumerate (depth, node)
NodeEnter
andNodeLeave
are returned whenever entering or leaving nodes.