opentap/OpenTap.Python

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

Opened this issue · 0 comments

The gist of Issue #144 (comment) is that

  • Documentation/TAP_Python_Help/Development_Process_Overview.md
  • Documentation/TAP_Python_Help/Virtual_Environments.md

are not referenced in:

sidebar: [
['/', "Welcome"],
['TAP_Python_Help/Prerequisites.md', 'Prerequisites'],
[ 'TAP_Python_Help/Getting_Started.md', 'Getting Started'],
[ 'TAP_Python_Help/Creating_a_plugin.md', 'Creating a New Plugin'],
[ 'TAP_Python_Help/New_Project_Creation.md', 'New Project Creation'],
[ 'TAP_Python_Help/Code_Examples.md', 'Example Code'],
[ 'TAP_Python_Help/Debugging.md', 'Debugging'],
['TAP_Python_Help/Limitations.md', 'Limitations'],
['TAP_Python_Help/Migration_Notes.md', 'Migrating from 2.X'],
{
title: "Release Notes",
children:
[
['Release_Notes/ReleaseNotes_3_0.md', "Version 3.0"],
['Release_Notes/ReleaseNotes_2_4.md', "Version 2.4"],
['Release_Notes/ReleaseNotes_2_3_1.md', "Version 2.3.1"],
['Release_Notes/ReleaseNotes_2_3.md', "Version 2.3.0"],
['Release_Notes/ReleaseNotes_2_0.md', "Version 2.0.0"],
['Release_Notes/ReleaseNotes_1_1.md', "Version 1.1.0"],
]
}
]

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:

- [OpenTAP Python Help](Readme.md)

- [Python Development Setup for Ubuntu](Python_Development_Setup_for_Ubuntu.md)

- [Debugging with Microsoft Visual Studio](Debugging_with_Microsoft_Visual_Studio.md)

Finally, Documentation/TAP_Python_Help/Development_Process_Overview.md references the nonexistent:

For details on these steps, see [Creating an OpenTAP Plugin with Python for Windows](./Creating_a_plugin_with_Python_for_Windows.md).

So, it seems that:

  • Documentation/TAP_Python_Help/Index.md
  • Documentation/TAP_Python_Help/Development_Process_Overview.md

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.