matusnovak/doxybook2

unneeded twice Classes in markdown link anchor

devel0 opened this issue · 2 comments

devel0 commented

platform: Ubuntu 20.04
doxybook2 version: v1.3.0

behavior
in class doc file ( example ) there is a unneeded Classes/ prefixed path that makes navigation not working. ( try to click on a function )

expected
no Classes/ prefix to allow link work

repro

git clone https://github.com/devel0/iot-stepper-motor.git
cd iot-stepper-motor
git checkout issue-doxybook2
./build-doc.sh
matusnovak commented

Hi @devel0

That's because your baseUrl in your config file has is empty. This tool expects you to provide some base url so that links can be properly formed.

In your particular example, if you wish to view the documentation from GitHub directly, your base url should be your output folder -> "baseUrl": "https://github.com/devel0/iot-stepper-motor/tree/main/data/api/".

If you wish to view the documentation from GitHub pages, it should be: https://iot-stepper-motor.github.com/devel0/ + <folder_path>.

Since you have no baseUrl set, the links are relative in your web browser, so that's why you see .../classes/classes/....

I am currently working on refactoring this tool so that this problem will be solved by not requiring the baseUrl property. But it's not going to be any time soon.

devel0 commented

Hi @matusnovak

many thanks, I confirm it worked