Move Key Commands doc script out of base repo folder#16024
Merged
Conversation
See test results for failed build of commit a9b60ce428 |
Contributor
|
Shouldn't |
Member
Author
|
Thanks @lukaszgo1 - missed committing it |
39578f0 to
8bbdedc
Compare
michaelDCurran
approved these changes
Jan 11, 2024
This comment was marked as off-topic.
This comment was marked as off-topic.
Member
Author
|
This appears to not be relevant to this PR. Please open a new issue with more information - I'm not sure what you mean by this comment. Please include in the issue what files are causing problems, what the problems are, etc. |
5 tasks
seanbudd
pushed a commit
that referenced
this pull request
Jan 19, 2024
Related #15945, #16024 Summary of the issue: The documentation folder in the NVDA directory contains files that the user does not need. For example: keyCommandsDoc.py Description of user facing changes The structure of the subfolders in documentation is the same as in the release version, with documentation/styles.css removed. Description of development approach In setup.py, exclude the corresponding file
Adriani90
pushed a commit
to Adriani90/nvda
that referenced
this pull request
Mar 13, 2024
Clean up of nvaccess#15945 Summary of the issue: The key commands doc generator script is in the base folder of the repository - it should be moved to a folder to keep the base repo tidy. I propose it is moved to user_docs - particularly because of its relation to the docs, and the fact that the t2tconf files will be removed. The documentation for key commands is lacking in the wiki: https://github.com/nvaccess/nvda/wiki/TranslatingUserGuide The inline documentation in the module covers the syntax more thoroughly and should be moved to project docs.
Adriani90
pushed a commit
to Adriani90/nvda
that referenced
this pull request
Mar 13, 2024
Related nvaccess#15945, nvaccess#16024 Summary of the issue: The documentation folder in the NVDA directory contains files that the user does not need. For example: keyCommandsDoc.py Description of user facing changes The structure of the subfolders in documentation is the same as in the release version, with documentation/styles.css removed. Description of development approach In setup.py, exclude the corresponding file
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to issue number:
Clean up of #15945
Summary of the issue:
The key commands doc generator script is in the base folder of the repository - it should be moved to a folder to keep the base repo tidy.
I propose it is moved to user_docs - particularly because of its relation to the docs, and the fact that the t2tconf files will be removed.
The documentation for key commands is lacking in the wiki: https://github.com/nvaccess/nvda/wiki/TranslatingUserGuide
The inline documentation in the module covers the syntax more thoroughly and should be moved to project docs.
Description of user facing changes
None
Description of development approach
Move folder
Testing strategy:
Test building user docs including key commands.
Known issues with pull request:
None
Code Review Checklist: