class

Myst::Doc::RootDoc

Inherits Reference / Object

Constructors

Instance methods

constants
Source
constants=(constants : Hash(String, Myst::Doc::ConstDoc))
Source
doc=(doc : String | Nil)
Source
homepage_url
Source
homepage_url=(homepage_url : String | Nil)
Source
kind
Source
kind=(kind : Myst::Doc::Kind)
Source
logo_url
Source
logo_url=(logo_url : String | Nil)
Source
methods
Source
methods=(methods : Hash(String, Myst::Doc::MethodDoc))
Source
project_name

These properties are meta information about the project being documented. These are pulled from the .mystdoc.yml file in the project's directory if one exists. Otherwise, they are mostly left nil.

Source
project_name=(project_name : String | Nil)

These properties are meta information about the project being documented. These are pulled from the .mystdoc.yml file in the project's directory if one exists. Otherwise, they are mostly left nil.

Source
submodules

These properties essentially mirror ModuleDoc and are generated by the tool's scan of Myst source files.

Source
submodules=(submodules : Hash(String, Myst::Doc::ModuleDoc))

These properties essentially mirror ModuleDoc and are generated by the tool's scan of Myst source files.

Source
subtypes
Source
subtypes=(subtypes : Hash(String, Myst::Doc::TypeDoc))
Source
version
Source
version=(version : String | Nil)
Source