jazzy
jazzy copied to clipboard
Inconsistent base directory for relative paths in YAML config file
I have noticed that output
and readme
seem to be relative to the config file but documentation
and abstract
are relative to the current working directory.
My setup:
myproject
|- build
| |- doc
|- doc
| |- README.md
| |- makedoc.sh
| |- jazzy.yaml
| |- guides
| | |- Getting Started.md
|- SwiftModule
|- myproject.xcodeproj
Since I want it to be run from myproject
, script makedoc.sh
is essentially this:
jazzy --clean --config doc/jazzy.yaml
Running doc/makedoc.sh
from myproject
, I need to configure like so:
output: ../build/doc
readme: README.md
documentation: doc/guides/*.md
This is quite confusing. All paths should use the same base diretory.