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

fix #8419 fix #8420 ; workaround #6071 workaround nim-lang/website#98 #8423

Merged
merged 2 commits into from
Jul 30, 2018

Conversation

timotheecour
Copy link
Member

@timotheecour timotheecour commented Jul 24, 2018

/cc @Varriount

eg usage:

./koch web --output:/tmp/d20
open /tmp/d20/index.html # see website and docs, with non-broken links

./koch web --output:/tmp/d20 --git.commit:devel
# also shows correct source links (pertain to branch devel instead of stable on website)

./koch web --output:/tmp/d20 --git.commit:myfeaturebranch --git.url:https://github.com/timotheecour/Nim
# source/edit links use provided base url, so we can see docs for un-merged PR, or un-pushed or old commit 

#NOTE: can use --git.commit:`git rev-parse --abbrev-ref HEAD` to get current branch

./koch web --output:/tmp/d20 --onlyDocs  --git.commit:devel
open /tmp/d20/docs/ospaths.html # see docs for ospaths.html (avoids building rest)
  • Abroken: this PR takes care of making the local links works by setting docHTMLOutput to $output / "docs" when user provides --output
    (before that PR, locally generated docs leads to broken links when starting from web/upload, eg: file:///Users/timothee/git_clone/nim/Nim/web/upload/documentation.html has href to nonexisting file:///Users/timothee/git_clone/nim/Nim/web/upload/docs/lib.html)

for future PR:

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