Modules

explicit

Not really supported. There is a directive but it changes the current ‘namespace’ or something.

auto module

More auto doco here http://www.sphinx-doc.org/en/stable/ext/autodoc.html

Use :noindex: when you have already autodoc’d something and its being added repeatedly to the documentation indexes etc. Don’t want duplicates.

server1.views.demo1(request)

server1.views.demo2(request)

server1.views.home(request)

auto module again

lib.validate_lists.ensure_dicts_have_keys(list_of_dicts, keys_spec, warn_extra_keys=False)

Ensure that dictionaries in list ‘znodes’ have the expected keys. ‘keys_spec’ is a code for specifying which keys

lib.validate_lists.ensure_is_list(paths_list)

lib.validate_lists.ensure_is_list_of_strings(paths_list)

Ensure ‘paths_list’ is a list of strings

class lib.tree.NodeData(url)

class lib.tree.PathTree(tree=None, deep=False)

Basic tree operations are accomplished via identifiers:

tree[id] return node node.fpointer returns list of children ids node.bpointer returns list of parent ids

Each treelib node has

tag nice name, a pure file or directory name with no path e.g. ‘b’ or ‘c.py’ identifier unique id, full path name e.g. ‘a/b/c.py’. If dir then no trailing slash e.g. ‘a/b’

ROOT_ID = 'root'

create_root()

path_to_subtree(path)

lib.tree.byteify(input)

lib.tree.paths_to_modules(paths)

@:param: paths - PU dict :returns: list of module dictionaries PUK, no dirs

lib.tree.paths_to_tree_paths(paths)

@:param: paths - PU dict :returns: list of path dictionaries PUNA, incl. dirs

lib.tree.pretty(d, indent=0)

lib.util.whosdaddy()

lib.util.whosgranddaddy()

auto module tricky

This will just pull out the lib.popular_repos.repos_static module’s docstring and no members are listed cos we don’t have the :members: directive

Watch out, the directive :special-members: lists things with __

lib.popular_repos.repos_static

This repos_static module contains data structures on various curated python repositories on github, including their:

• repo
• user
• description (optional)

Not sure what this is:

<option value="0">UML interesting Python</option>
<option value="1">Github trending Python</option>
<option value="2">Search for highest forked</option>
<option value="3">Reddit best written Python</option>
<option value="4">Top 30 Github Python 2014</option>

module variables

This is a module

lib.sample_module.A = 100

this variable is used for x

lib.sample_module.B = 200

this variable is used for blah

class lib.sample_module.C

class lib.sample_module.D

lib.sample_module.fred()