fix #8419 fix #8420 ; workaround #6071 workaround nim-lang/website#98 #8423
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
/cc @Varriount
o
is actually unused and docs output dir hardcoded regardless of o #8419Source
link (Edit
one is ok though) #8420devel
branch website#98--git.devel
to override hardcodeddevel
in config/nimdoc.cfg ; useful for git repos in which the development branch is not devel (it usually ismaster
, notdevel
)eg usage:
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:
git rev-parse --abbrev-ref HEAD
as value for git.commit which is a good default when developping: we want to see docs for branch we're currently on => see [WIP] [doc] miscellaneous issues #8477docSeeSrcUrl
in docs (instead, reference git.commit, git.devel, git.url)=> tracked here nim doc2 ignores --docSeeSrcUrl parameter #6071