dev/docs/index

package source reference index support

Dependency Graph

dev/docs/index: Library Dependencies

View the full-size SVG (svg) or PDF (pdf) image or graphviz source (dot)

View color source code (raw) for this file

View reStructuredText (rst) source code for this page

Source File Index

docs_gen_html_index()

Generates documentation index file

File Sections

Script Groups

is_docs_gen_index_group_extension()

Determines whether the current group consists of top-level exensions.

Returns: Success if $group_name is null.

docs_gen_index_group()

Generates documentation for a given script group ($1). If the group name is empty, then generates documentation for top-level extension scripts.

$1 - Name of script group.

docs_gen_index_extension()

Generates documentation for top-level runtime and extension libraries.

docs_gen_index_subgroup()

Generates documentation for a single script group.

docs_gen_index_group_files()

Generates the index file the files in a single group.

docs_gen_index_group_file()

Generates an index entry for a single file in a script group.

File Entries

Symbol index

TODO: implement symbol index, giving a <file:line> pair for each appearance
html_p "This page provide links to the programming interfaces and
commands provided by the <code>$PKG</code> package."

View the Developer Guide Index

View the Reference Manual Index


Generated on Fri Jul 28 14:37:28 PDT 2017 by mcsh d14 v0.23.0.