Remove warning about TraitsDoc #1383
Merged
Conversation
This file contains 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
This PR removes a potentially confusing warning about TraitsDoc, which is now ancient history. (From some historical code diving and searching, TraitsDoc here refers to a file `traitsdoc.py` which contained a Sphinx extension; the file was typically copied directly into the `docs` directory of projects that needed it.)
|
Thanks, @rahulporuri. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR removes a potentially confusing warning about TraitsDoc, which is now ancient history.
From some historical code diving and searching, TraitsDoc here refers to a single file
traitsdoc.pywhich contained a Sphinx extension; the file was typically copied directly into thedocsdirectory of projects that needed it.traits.util.trait_documenteris the official "right way" to do this.Checklist
TestsNot applicabledocs/source/traits_api_reference)Update User manual (Not needed - TraitsDoc not referred to from the user manualdocs/source/traits_user_manual)Update type annotation hints inNot applicabletraits-stubs