Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/userguide/diviner.diviner
| Show All 39 Lines | "groups" : { | ||||
| "reverse" : { | "reverse" : { | ||||
| "name" : "Undoing Stuff" | "name" : "Undoing Stuff" | ||||
| } | } | ||||
| } | } | ||||
| } | } | ||||
| The properties in this file are: | The properties in this file are: | ||||
| - `name`: Required. Short, unique name to identify the documentation book. This | - `name`: Required. Short, unique name to identify the documentation book. | ||||
| will be used in URIs, so it should not have special characters. Good names | This will be used in URIs, so it should not have special characters. Good | ||||
| are things like `"example"` or `"libcabin"`. | names are things like `"example"` or `"libcabin"`. | ||||
| - `root`: Required. The root directory (relative to the `.book` file) which | - `root`: Required. The root directory (relative to the `.book` file) which | ||||
| documentation should be generated from. Often this will be a value like | documentation should be generated from. Often this will be a value like | ||||
| `"../../"`, to specify the project root (for example, if the `.book` file | `"../../"`, to specify the project root (for example, if the `.book` file | ||||
| is in `project/src/docs/example.book`, the value `"../../"` would generate | is in `project/src/docs/example.book`, the value `"../../"` would generate | ||||
| documentation from the `project/` directory. | documentation from the `project/` directory. | ||||
| - `title`: Optional. Full human-readable title of the documentation book. This | - `title`: Optional. Full human-readable title of the documentation book. This | ||||
| is used when there's plenty of display space and should completely describe | is used when there's plenty of display space and should completely describe | ||||
| the book. Good titles are things like `"Example Documentation"`, or | the book. Good titles are things like `"Example Documentation"`, or | ||||
| Show All 26 Lines | |||||