class Myst::Doc::RootDoc

Defined in:

myst/tools/doc/root_doc.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new #

[View source]

Instance Method Detail

def constants : Hash(String, Myst::Doc::ConstDoc) #

[View source]
def constants=(constants : Hash(String, Myst::Doc::ConstDoc)) #

[View source]
def doc : String | Nil #

[View source]
def doc=(doc : String | Nil) #

[View source]
def homepage_url : String | Nil #

[View source]
def homepage_url=(homepage_url : String | Nil) #

[View source]
def kind : Myst::Doc::Kind #

[View source]
def kind=(kind : Myst::Doc::Kind) #

[View source]
def logo_url : String | Nil #

[View source]
def logo_url=(logo_url : String | Nil) #

[View source]
def methods : Hash(String, Myst::Doc::MethodDoc) #

[View source]
def methods=(methods : Hash(String, Myst::Doc::MethodDoc)) #

[View source]
def 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.


[View source]
def 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.


[View source]
def submodules : Hash(String, Myst::Doc::ModuleDoc) #

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


[View source]
def submodules=(submodules : Hash(String, Myst::Doc::ModuleDoc)) #

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


[View source]
def subtypes : Hash(String, Myst::Doc::TypeDoc) #

[View source]
def subtypes=(subtypes : Hash(String, Myst::Doc::TypeDoc)) #

[View source]
def version : String | Nil #

[View source]
def version=(version : String | Nil) #

[View source]