atelier.sphinxconf.base¶
(This module’s source code is available here.)
Basic extension
Sphinx setup used to build the Lino documentation.
Thanks to
Functions
| actor_role(typ, rawtext, text, lineno, inliner) | |
| autodoc_add_srcref(app, what, name, obj, ...) | |
| autodoc_skip_member(app, what, name, obj, ...) | |
| blogref_role(name, rawtext, text, lineno, ...) | Inserts a reference to the blog entry of the specified date. |
| 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. |
| i2d(i) | Convert int to date. |
| import_module(name[, package]) | Import a module. |
| message_role(typ, rawtext, text, lineno, inliner) | |
| nested_parse_with_titles(state, content, node) | Version of state.nested_parse() that allows titles and does not require titles to have the same decoration as the calling document. |
| setup(app) | The Sphinx setup function used for Lino-related documentation trees. |
| split_explicit_title(text) | Split role content into title and target, if given. |
| srcref(mod) | Return the source file name for usage by Sphinx’s srcref role. |
| unused_srcref_role(typ, rawtext, text, ...) |
Classes
| Directive(name, arguments, options, content, ...) | Base class for reStructuredText directives. |
| Path |
- atelier.sphinxconf.base.blogref_role(name, rawtext, text, lineno, inliner, options={}, content=[])¶
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.
- atelier.sphinxconf.base.get_blog_url(env, today)¶
Return the URL to your developer blog entry of that date.
- atelier.sphinxconf.base.setup(app)¶
The Sphinx setup function used for Lino-related documentation trees.
- atelier.sphinxconf.base.srcref(mod)¶
Return the source file name for usage by Sphinx’s srcref role. Returns None if the source file is empty (which happens e.g. for __init__.py files whose only purpose is to mark a package).
Examples:
>>> import atelier >>> from atelier import sphinxconf >>> from atelier.sphinxconf import base >>> print(srcref(atelier)) https://github.com/lsaffre/atelier/blob/master/atelier/__init__.py >>> print(srcref(sphinxconf)) https://github.com/lsaffre/atelier/blob/master/atelier/sphinxconf/__init__.py >>> print(srcref(base)) https://github.com/lsaffre/atelier/blob/master/atelier/sphinxconf/base.py