autoclasstoc.utils.pick_class
- autoclasstoc.utils.pick_class(qual_name, env)[source]
Figure out which class to make the TOC for.
We can either be given this information as an argument, or we can try to figure it out from the context (e.g. the
autoclass
orpy:class
currently being processed).- Parameters:
qual_name (str) – The name of the class to pick, or None if the class should be inferred from the environment.
env (sphinx.environment.BuildEnvironment) – This object is available as
self.env
fromSphinxDirective
subclasses.