Documenting a single namespace hierarchy

The simplest use of Ruff! is to generate documentation for a single namespace or namespace hierarchy in HTML format. The command document_namespaces accomplishes this. The following example  generates documentation for all classes and procs in the namespace ::some_namespace and its descendents. The output is written to the file some_namespace.html.

package require ruff; # Loads Ruff! into the interpreter
::ruff::document_namespaces html ::some_namespace -output some_namespace.html -recurse true 

The above uses the built-in HTML output formatter. External formatters like doctools require another step to be invoked and may themselves have additional options you can use to control the final output. Refer to the documentation for those tools for details.