Skip to content

Commit

Permalink
Update to include link to TOML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
timothycrosley committed Sep 17, 2019
1 parent f65d9ff commit c006a41
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/quick_start/4.-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ Troubleshooting = "TROUBLESHOOTING.md"
"4. Configuration" = "docs/quick_start/4.-configuration.md"
```

For more information see [MkDocs configuration](https://www.mkdocs.org/user-guide/configuration/) and [pdoc3 configuration](https://github.com/pdoc3/pdoc/blob/master/pdoc/templates/config.mako).
Note that the above utilizes [TOMLs double bracket syntax to specify a List of Dicts](https://github.com/toml-lang/toml/blob/master/README.md#user-content-array-of-tables).

For more information about available configuration options see [MkDocs configuration](https://www.mkdocs.org/user-guide/configuration/) and [pdoc3 configuration](https://github.com/pdoc3/pdoc/blob/master/pdoc/templates/config.mako).

!!! warning
While portray allows configuring any aspect of MkDocs or pdoc3, it only allows that configuration to be defined in a `pyproject.toml` file. Any other configuration files normally used for these projects will be ignored.

0 comments on commit c006a41

Please sign in to comment.