Fix errors on front page of user manual #1396
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
mdickinson
reviewed
Jan 15, 2021
| <http://docs.enthought.com/traitsui/traitsui_user_manual/index.html>`_ | ||
| * Traits Technical Notes | ||
| * `Traits API Reference <https://docs.enthought.com/traits/traits_api_reference/index.html>`_ | ||
| * `Traits Technical Notes <https://docs.enthought.com/traits/changelog.html>`_ |
There was a problem hiding this comment.
I don't know what this was originally supposed to refer to either; even going as far back as Traits 4.0, this wasn't linked to anything.
How about we just drop this entry? That then leaves us with the awkwardness of an itemised list with a single item, so maybe we should simply reword the sentence that introduces this list, and link to the API reference directly from it. Thoughts?
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.
fixes #1373
This PR removes an unnecessary link to the TraitsUI user manual on the Intro page of the traits user manual. It also adds links to the bullets for "Traits API Reference" and "Traits Technical Notes". "Traits Technical Notes" is now linked to the changelog (I wasn't exactly sure what this was intended to be a reference to, this change should be confirmed by a reviewed)
Additionally, the buttons at the top of the page labels are changed. The first button is now labelled "Traits 6.1 Documentation" as that is where that actually links to. The second link comes from the title tag of individual pages (see: https://www.sphinx-doc.org/en/master/usage/configuration.html). Building the docs and navigating to different pages the links seem to be labelled correctly now to the pages they actually link to.
Checklist
[ ] Tests[ ] Update API reference (docs/source/traits_api_reference)docs/source/traits_user_manual)[ ] Update type annotation hints intraits-stubs