module sphinxext.sphinx_blog_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_blog_extension
Defines blogpost directives. See Tutorial: Writing a simple extension, Creating reStructuredText Directives
Classes¶
class |
truncated documentation |
---|---|
Defines blogpost node. |
|
Defines blogpostagg node. |
|
Extracts information about a blog post described by a directive `` |
|
same but for the same post in a aggregated pages |
|
defines blogpostlist node, unused, kept as example |
|
unused, kept as example |
Functions¶
function |
truncated documentation |
---|---|
what to do when leaving a node blogpost the function should have different behaviour, depending on the format, or … |
|
what to do when leaving a node blogpost, the function should have different behaviour, depending on the format, … |
|
what to do when leaving a node blogpost, the function should have different behaviour, depending on the format, … |
|
unused, kept as example |
|
unused, kept as example |
|
setup for |
|
what to do when visiting a node blogpost the function should have different behaviour, depending on the format, … |
|
what to do when visiting a node blogpost the function should have different behaviour, depending on the format, … |
Methods¶
method |
truncated documentation |
---|---|
Fills the content of the node. |
|
Fill the node of an aggregated page. |
|
extracts the information in a dictionary and displays it if the environment is not null |
|
|
extracts the information in a dictionary and displays it if the environment is not null |
|
|
returns a suffix to add to a label, it should not be empty for aggregated pages |
|
returns a suffix to add to a label, it should not be empty for aggregated pages |
Documentation¶
Defines blogpost directives. See Tutorial: Writing a simple extension, Creating reStructuredText Directives
-
class
pyquickhelper.sphinxext.sphinx_blog_extension.
BlogPostDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
docutils.parsers.rst.Directive
Extracts information about a blog post described by a directive
.. blogpost::
and modifies the documentation if env is not null. The directive handles the following options:date: date of the blog (mandatory)
title: title (mandatory)
keywords: keywords, comma separated (mandatory)
categories: categories, comma separated (mandatory)
author: author (optional)
blog_background: can change the blog background (boolean, default is True)
lid or label: an id to refer to (optional)
-
blogpost_class
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_blog_extension.blogpost_node
-
fill_node
(node, env, tag, p, language_code, targetnode, sharepost)[source]¶ Fills the content of the node.
-
run
()[source]¶ extracts the information in a dictionary and displays it if the environment is not null
- Returns
a list of nodes
-
class
pyquickhelper.sphinxext.sphinx_blog_extension.
BlogPostDirectiveAgg
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirective
same but for the same post in a aggregated pages
-
blogpost_class
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_blog_extension.blogpostagg_node
-
fill_node
(node, env, tag, p, language_code, targetnode, sharepost)[source]¶ Fill the node of an aggregated page.
-
-
class
pyquickhelper.sphinxext.sphinx_blog_extension.
BlogPostListDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
docutils.parsers.rst.Directive
unused, kept as example
-
class
pyquickhelper.sphinxext.sphinx_blog_extension.
blogpost_node
(rawsource='', *children, **attributes)[source]¶ Bases:
docutils.nodes.Element
Defines blogpost node.
-
class
pyquickhelper.sphinxext.sphinx_blog_extension.
blogpostagg_node
(rawsource='', *children, **attributes)[source]¶ Bases:
docutils.nodes.Element
Defines blogpostagg node.
-
class
pyquickhelper.sphinxext.sphinx_blog_extension.
blogpostlist_node
(rawsource='', *children, **attributes)[source]¶ Bases:
docutils.nodes.General
,docutils.nodes.Element
defines blogpostlist node, unused, kept as example
-
pyquickhelper.sphinxext.sphinx_blog_extension.
depart_blogpost_node
(self, node)[source]¶ what to do when leaving a node blogpost the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
-
pyquickhelper.sphinxext.sphinx_blog_extension.
depart_blogpostagg_node
(self, node)[source]¶ what to do when leaving a node blogpost, the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
-
pyquickhelper.sphinxext.sphinx_blog_extension.
depart_blogpostagg_node_html
(self, node)[source]¶ what to do when leaving a node blogpost, the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
-
pyquickhelper.sphinxext.sphinx_blog_extension.
process_blogpost_nodes
(app, doctree, fromdocname)[source]¶ unused, kept as example
-
pyquickhelper.sphinxext.sphinx_blog_extension.
purge_blogpost
(app, env, docname)[source]¶ unused, kept as example
-
pyquickhelper.sphinxext.sphinx_blog_extension.
visit_blogpost_node
(self, node)[source]¶ what to do when visiting a node blogpost the function should have different behaviour, depending on the format, or the setup should specify a different function for each.