Skip to content

Provide syntax for specifying configuration #778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 11, 2017
Merged

Provide syntax for specifying configuration #778

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/CONFIG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Configuration - a `documentation.yml` file - will accomplish two goals:
* Organization: you can put top level documentation in order of importance
* Narration: you can add narrative sections - plain English writing - in
between autogenerated API documentation.

Specify the configuration file with the `--config` command-line option.
```sh
$ documentation build --config documentation.yml ...
```

Here's how `documentation.yml` works:

Expand Down