atelier.sphinxconf.blog¶
This Sphinx extension defines the blogger_year
and
blogger_index
directives.
Usage: add the following to your conf.py:
extensions += ['atelier.sphinxconf.blog']
And usually this file structure:
docs/blog/index.rst –> contains a main_blogindex directive (hidden toctree)
Individual blog entries are automatically created by inv blog
,
leading to a file structure like this:
docs/blog/2013/index.rst –> contains a
blogger_year
directivedocs/blog/2013/0107.rst –> a blog entry
docs/blog/2013/0108.rst –> another blog entry
docs/blog/2013/0108b.rst –> a second blog entry on January 8
The inv blog
command automatically creates yearly directories and
index.rst files when needed.
If you want a second separate blog entry on a same day, you must manually create a file.
Thanks to
(This module’s source code is available here.)
Functions
|
|
|
|
|
|
|
Return the monthname for month # n in specified language. |
|
|
|
Classes
|
|
|
A |
|
Directive to insert a blog master archive page toctree |
|
Directive to insert a year’s calendar |
-
atelier.sphinxconf.blog.
monthname
(n, language)¶ Return the monthname for month # n in specified language.
-
class
atelier.sphinxconf.blog.
BloggerYear
(env)¶ Bases:
object
A
BloggerYear
instance is created for each blogger_year directive.
-
class
atelier.sphinxconf.blog.
MainBlogIndexDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)¶ Bases:
atelier.sphinxconf.insert_input.InsertInputDirective
Directive to insert a blog master archive page toctree
-
class
atelier.sphinxconf.blog.
YearBlogIndexDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)¶ Bases:
atelier.sphinxconf.insert_input.InsertInputDirective
Directive to insert a year’s calendar