Corefhtml writer: use a relative docs_dir path in the JS script #120
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.
Issue description:
In the
write.corefhtml
package, thedocs_dir
parameter is supposed to contain a path relative to the directory where the HTML file is output. However, this is violated when the output directory is not the current working directory.Fix description:
The fix introduces
js_docs_dir
which should always contain a relative path to be used in the JS scripts. On the other hand, if the output directory is specified using thepath
parameter, thedocs_dir
is adjusted so that it is relative to the output path.TODO:
For the time being, it only works if the
path
parameter is specified. It is not adjusted if the output directory is specified using thefiles
parameter.