opentap / OpenTap.Python

Python integration for OpenTAP
Apache License 2.0
20 stars 6 forks source link

`Documentation/TAP_Python_Help/Virtual_Environments.md` not linked to `https://doc.opentap.io/OpenTap.Python/` #174

Open g-galante opened 3 months ago

g-galante commented 3 months ago

The gist of Issue https://github.com/opentap/OpenTap.Python/issues/144#issue-2021322917 is that

are not referenced in: https://github.com/opentap/OpenTap.Python/blob/d367d1274bd2ebf73e35e2526a2510ef08705258/Documentation/.vuepress/config.js#L15-L38

And the only remaining reference to them:

~/git/OpenTap.Python$ git grep -E 'Development_Process_Overview.md|Virtual_Environments.md'
Documentation/TAP_Python_Help/Index.md:- [Python Development Process Overview](Development_Process_Overview.md)

is in Documentation/TAP_Python_Help/Index.md, therefore their content is missing from https://doc.opentap.io/OpenTap.Python/.

In addition, Documentation/TAP_Python_Help/Index.md references several nonexistent files: https://github.com/opentap/OpenTap.Python/blob/d367d1274bd2ebf73e35e2526a2510ef08705258/Documentation/TAP_Python_Help/Index.md?plain=1#L2 https://github.com/opentap/OpenTap.Python/blob/d367d1274bd2ebf73e35e2526a2510ef08705258/Documentation/TAP_Python_Help/Index.md?plain=1#L4 https://github.com/opentap/OpenTap.Python/blob/d367d1274bd2ebf73e35e2526a2510ef08705258/Documentation/TAP_Python_Help/Index.md?plain=1#L9

Finally, Documentation/TAP_Python_Help/Development_Process_Overview.md references the nonexistent: https://github.com/opentap/OpenTap.Python/blob/d367d1274bd2ebf73e35e2526a2510ef08705258/Documentation/TAP_Python_Help/Development_Process_Overview.md?plain=1#L13

So, it seems that:

are stray and can be removed, whereas Documentation/TAP_Python_Help/Virtual_Environments.md is either to be included in Documentation/.vuepress/config.js, or linked from some other .md file, such as Documentation/TAP_Python_Help/Getting_Started.md.

If you advise on what to do, I can volunteer to submit a PR to resolve the issue.