Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix a few broken links in documentation #248

Merged
merged 2 commits into from
Dec 10, 2020
Merged

Conversation

aaronayres35
Copy link
Contributor

@aaronayres35 aaronayres35 commented Dec 9, 2020

fixes #171

Note when writing issue 171 I noticed the broken links on https://docs.enthought.com/apptools/. I had not built the documentation from master, and after doing so it seems that the majority of the links were working on master. I went through and checked links from the docs built on master and those that were still broken I have fixed here (only a few).

Checklist

  • Add a news fragment if this PR is news-worthy for end users. (see docs/releases/README.rst)

# substitutions

.. |PreferencesHelper| replace:: :class:`~apptools.preferences.preferences_helper.PreferencesHelper`
.. |ScopedPreferences| replace:: :class:`~apptools.preferences.scoped_preferences.ScopedPreferences`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that there is an open issue to move "Preferences in Envisage" to envisage (#202)
I'm unsure if we want to do that before the upcoming release? (if this were removed/moved over it wouldn't be available until another envisage release happens)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would definitely be nice to copy the docs before the release and like you said, we definitely can't remove the docs from apptools entirely. We'll need to go through a couple of minor versions of apptools before we can finally remove the docs from apptools entirely and simply point to envisage docs.

Copy link
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Numerous broken links in docs
3 participants