lib.roles.leanpub

Leanpub role for Docutils.

django_docutils.lib.roles.leanpub.leanpub_role(name, rawtext, text, lineno, inliner, options=None, content=None)

Role for linking to leanpub page.

Return type:

django_docutils.lib.roles.types.RoleFnReturnValue

Parameters:

• name (str)

• rawtext (str)

• text (str)

• lineno (int)

• inliner (Inliner)

• options (dict[str, Any] | None)

• content (str | None)

Examples

the-tao-of-tmux:

:leanpub:`the-tao-of-tmux`

my book:

:leanpub:`my book <the-tao-of-tmux>`

The Tao of tmux:

:leanpub:`The Tao of tmux <the-tao-of-tmux:read>`