atelier.sphinxconf.base

Basic extension

Sphinx setup used to build the Lino documentation.

:blogref:

Inserts a reference to the blog entry of the specified date.

Instead of writing :doc:`/blog/2011/0406` it is better to write :blogref:`20110406` because the latter works between Sphinx trees and also supports archived blog entries.

Thanks to

(This module’s source code is available here.)

Functions

actor_role(typ, rawtext, text, lineno, inliner)

autodoc_add_srcref(app, what, name, obj, …)

Add a reference to the module’s source code.

autodoc_skip_member(app, what, name, obj, …)

blogref_role(name, rawtext, text, lineno, …)

coderef_role(typ, rawtext, text, lineno, inliner)

command_parse(env, sig, signode)

get_blog_url(env, today)

Return the URL to your developer blog entry of that date.

html_page_context(app, pagename, …)

message_role(typ, rawtext, text, lineno, inliner)

process_signature(app, what, name, obj, …)

setup(app)

unused_srcref_role(typ, rawtext, text, …)

atelier.sphinxconf.base.autodoc_add_srcref(app, what, name, obj, options, lines)

Add a reference to the module’s source code. This is being added as listener to the autodoc-process-docstring signal.

atelier.sphinxconf.base.get_blog_url(env, today)

Return the URL to your developer blog entry of that date.