confdoc Namespace Reference

Generates the doc/config-files.dox, which documents configuration files. More...

Detailed Description

Generates the doc/config-files.dox, which documents configuration files.

Run by the documentation generator in sorc/doc/compile. Syntax:

../../ush/confdoc.py ../../parm/hwrf_basic.conf ... more ... > ../../doc/config-files.dox

That will read in the listed conf files, process Doxygen-like comments, and generate multiple pages of documentation. There will be one page for each conf file, another page listing all sections and options, and a final top-level page

The documentation comments are similar to the syntax Doxygen uses for Python, but with the addition of ";;" comments for documenting options on the same line they are defined:

## Brief description of section
#
# Detailed description of section
[section]
option1 = value ;; Brief description of option1

## Brief description of option2
# 
# Detailed description of option2
option2 = value

The descriptions can contain the usual Doxygen and Markdown syntax.

There are a number of pages and sections generated with the following anchors. These are the page anchors:

• conf-files — Main page that lists all subpages.
• conf-options — Subpage that contains all section and option documentation
• conf-file-[filename] — Page for the specified file. Any dots (".") are replaced with underscores ("_") in the filename.

These are the section anchors:

• conf-sec-runwrf — Documentation section for the [runwrf] section
• conf-sec-runwrf-wm3c_ranks — Documentation subsection for the wm3c_ranks option in the [runwrf] section. Any percent signs ("%") in the option name are replaced with "-P-"
• conf-[filename]-runwrf — Documentation for the [runwrf] section in the specified file
• conf-[filename]-runwrf-wm3c_ranks — Documentation for the [runwrf] section's wm3c_ranks option in the specified file.

Classes
class	coredoc
	Subclass of override, for documenting the core configuration files. More...
class	docbase
	Stores documentation for all configuration options and sections. More...
class	override
	Subclass of docbase for documenting files that override the base configuration. More...
class	parsefile
	Config file parser. More...

Functions
def	main (args)
	Main program for confdoc. More...

Function Documentation

def confdoc.main

(

args

)

Main program for confdoc.

See the confdoc documentation for details.

Definition at line 772 of file confdoc.py.