Skip to content
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.

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

Inconsistent base directory for relative paths in YAML config file #772

Open
reitzig opened this issue Apr 21, 2017 · 0 comments
Open

Inconsistent base directory for relative paths in YAML config file #772

reitzig opened this issue Apr 21, 2017 · 0 comments
Labels

Comments

@reitzig
Copy link

reitzig commented Apr 21, 2017

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants