5.2. sphinx.domains.c

The C language domain.

copyright:Copyright 2007-2016 by the Sphinx team, see AUTHORS.
license:BSD, see LICENSE for details.

5.2.1. Functions

l_(string) A lazy version of gettext.
make_refnode(builder, fromdocname, ...[, title]) Shortcut to create a reference node.

5.2.2. Classes

CDomain(env) C language domain.
CObject(name, arguments, options, content, ...) Description of a C language object.
CXRefRole([fix_parens, lowercase, ...])
Domain(env) A Domain is meant to be a group of “object” description directives for objects of a similar nature, and corresponding roles to create references to them.
Field(name[, names, label, has_arg, ...]) A doc field that is never grouped.
ObjType(lname, *roles, **attrs) An ObjType is the description for a type of object that a domain can document.
ObjectDescription(name, arguments, options, ...) Directive to describe a class, function or similar object.
TypedField(name[, names, typenames, label, ...]) A doc field that is grouped and has type information for the arguments.
XRefRole([fix_parens, lowercase, nodeclass, ...]) A generic cross-referencing role.