Bug: Documentation for second level directories and their child dirs fails to link to source code #19
Labels
🐞 bug
Something isn't working
🎉 fix released
This issue has been addressed in the latest release
👋 response needed
Awaiting for a response from a reporter
Hi thanks for all your work on this
Describe the bug
When running the following for a complex lib, documentation for second level directories and their child dirs fails to link to source code
To Reproduce
Steps to reproduce the behavior:
my_module/__init__.py
imports frommy_module/foo/bar.py
handsdown --source-code-path ../.. --cleanup
my_module/foo/bar.py
fails as the link is for../../my_module/foo/bar.py
rather than../../../my_module/foo/bar.py
Expected behavior
Viewing source code for
my_module/foo/bar.py
succeeds as the link is../../../my_module/foo/bar.py
. I imagine the implementation for this would be similar to linking back to the root MODULES.md (../../MODULES.md#cli2gui-modules
) This may change the path passed too as if the repo looks likeThen it would make more sense to run
handsdown --source-code-path .. --cleanup
in place ofhandsdown --source-code-path ../.. --cleanup
(if--source-code-path
is specified the relative paths can be built similarly to how they are to link to MODULES.md)Screenshots
If applicable, add screenshots to help explain your problem.
To clarify the screenshot:
docs/cli2gui/application/application.py
cli2gui/application/application.py
Desktop:
Additional context
I've included some of this above. Please let me know if you'd like anything clarifying - it's a little late so apologies if any of the above came out as utter nonsense
Thank you for your time :)
The text was updated successfully, but these errors were encountered: