Documentation

‌

Autogenerated Documentation

Autogenerate a symbol page:

DocGen[DocGen]

Autogenerate an overview guide for a context

DocGen["Guide", "PacletManager`"]

(*Out:*)

Autogenerate documentation paclets from a set of contexts:

<<OAuth` 
 DocGen["Paclet", 
  {
    "OtherClient`",
    "KeyClient`",
    "OAuthClient`",
    "OAuth`"
    },
  Method->{
    Directory->$TemporaryDirectory
    }
  ]

‌

Documentation Templates

Generate a template notebook for writing a tutorial

<<BTools`Paclets` 
 DocGen["Tutorial", "BTools", Method->"Template","CreateDocument"->True]

The "SymbolPage" , "Guide" , and "Tutorial" types support "Template" , "Notebook" , and "Save" methods.

We can write content in the template notebook and use the bar on the top to generate a tutorial.

‌

Front-End Resources

The DocGen stylesheet supports the DocGen package. It provides a toolbar for adding common templates, a hopefully simple-enough flow. Examples of a documentation template notebook can be found here .

‌

Examples

For more examples, see the DocumentationExamples pages