diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-02-05 08:59:49 -0500 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-02-05 09:00:52 -0500 |
| commit | e52a1299f5cc121d84d7fc3b4f01594fcae030c1 (patch) | |
| tree | 605bf88db8cf7f24412efb2e03b29f0106a79eb7 /doc/exts | |
| parent | adff0df212bd3d7eabc3717a78a7f3b7cfa78945 (diff) | |
| download | bcfg2-e52a1299f5cc121d84d7fc3b4f01594fcae030c1.tar.gz bcfg2-e52a1299f5cc121d84d7fc3b4f01594fcae030c1.tar.bz2 bcfg2-e52a1299f5cc121d84d7fc3b4f01594fcae030c1.zip | |
documented xmlschema sphinx extension options/flags
Diffstat (limited to 'doc/exts')
| -rw-r--r-- | doc/exts/xmlschema.py | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/exts/xmlschema.py b/doc/exts/xmlschema.py index 8a68902e1..727b4bbd0 100644 --- a/doc/exts/xmlschema.py +++ b/doc/exts/xmlschema.py @@ -10,6 +10,30 @@ Provides the following directives: * ``.. xml:attributegroup:: <name>``: Document an attributeGroup * ``.. xml:element:: <name>``: Document an XML element +Each directive supports the following options: + +* ``:namespace: <ns>``: Specify the namespace of the given entity +* ``:nochildren:``: Do not generate documentation for child entities +* ``:noattributegroups:``: Do not generate documentation about + attribute groups +* ``:nodoc:``: Do not include the documentation included in the entity + annotation +* ``:notext:``: Do not generate documentation about the text content + of the entity +* ``:onlyattrs: <attr>,<attr>``: Only generate documentation about the + comma-separated list of attributes given +* ``:requiredattrs: <attr>,attr>``: Claim that the attributes named in + the given comma-separated list are required, even if they are not + flagged as such in the schema. +* ``:linktotype: [<type>,<type>]``: If used as a flag, link to + documentation on all child types and elements. If a list is given, + only link to those types given. (The default is to generate full + inline docs for those types.) +* ``:noautodep: [<name>,<name>]``: Do not automatically generate docs + for any dependent entities. +* ``:inlinetypes: <type>,<type>``: Override a default ``:linktotype:`` + setting for the given types. + Provides the following roles to link to the objects documented above: * ``:xml:schema:`<name>```: Link to an XML schema @@ -759,6 +783,8 @@ class XMLDomain(Domain): def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): + if typ in ['complexType', 'simpleType']: + typ = 'type' if target in self.data[typ]: docname, labelid = self.data[typ][target] else: |