Crate user_doc_doc_data[−][src]
Expand description
Metadata regarding user-facing documentation
Structs
Enums
When expanding to directories, this determines the naming scheme
A documentation or a Docdict Each documentable has a name string
Attribute helpers
Constants
How much text to show in previews
Statics
The repository of all active docs
Output directory for persisting data between compilation-time and run-time
Functions
Load the docs from a file path This is necessary because the global store cannot persist between compilation time and runtime.
Make a string from a DocDict key
Save the global store to a file path at the given directory path This is necessary because the global store cannot persist between compilation time and runtime See OUTPUT_DIR_PATH
Type Definitions
Entries in the DocDict take this form
A tree-dictionary of docs
The level of a markdown header