search

wultra / docucheck

Tool for validating Wultra's documentation
Apache License 2.0
2 stars 2 forks source link

Single file document cannot point to source code in the same repo #37

Open hvge opened 3 years ago

hvge commented 3 years ago

If singleDocumentFile is used for the repository, then such documentation cannot point to the source code in the same repository and generate external link to github. This is because docucheck is using ../ to determine whether the link points to the resource that must be linked directly to external github. So, when docs folder is used, the external links points to at least one folder up and such links begins with ../some-relative-path. In opposite to this, the single file documentation, which is typically located at the root of repo, so it is impossible to reference resource with ../ path prefix.

The related issue is that single file document cannot use inline images from the repository for the same reason. Such image will not be copied in the data collection phase.

hvge commented 3 years ago

Known workaround for this is to use full link to develop branch and use #docucheck-keep-link anchor.