From 083ef2f851c3e8d458c685d8d188f98c70c14fb2 Mon Sep 17 00:00:00 2001 From: Aaron Ayres Date: Wed, 9 Dec 2020 14:55:27 -0600 Subject: [PATCH 1/2] fix a few broken links in documentation --- docs/source/preferences/PreferencesInEnvisage.rst | 11 +++++++---- docs/source/scripting/introduction.rst | 4 ++-- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/source/preferences/PreferencesInEnvisage.rst b/docs/source/preferences/PreferencesInEnvisage.rst index 92eb7f259..931897eb6 100644 --- a/docs/source/preferences/PreferencesInEnvisage.rst +++ b/docs/source/preferences/PreferencesInEnvisage.rst @@ -7,7 +7,7 @@ This section discusses how an Envisage application uses the preferences mechanism. Envisage tries not to dictate too much, and so this describes the default behaviour, but you are free to override it as desired. -Envisage uses the default implementation of the ScopedPreferences_ class which +Envisage uses the default implementation of the |ScopedPreferences| class which is made available via the application's 'preferences' trait:: >>> application = Application(id='myapplication') @@ -19,7 +19,7 @@ Hence, you use the Envisage preferences just like you would any other scoped preferences. It also registers itself as the default preferences node used by the -PreferencesHelper_ class. Hence you don't need to provide a preferences node +|PreferencesHelper| class. Hence you don't need to provide a preferences node explicitly to your helper:: >>> helper = SplashScreenPreferences() @@ -45,5 +45,8 @@ e.g. To contribute a preference file for my plugin I might use:: def get_preferences(self, application): return ['pkgfile://mypackage:preferences.ini'] -.. _PreferencesHelper: ../../enthought/preferences/preferences_helper.py -.. _ScopedPreferences: ../../enthought/preferences/scoped_preferences.py +.. + # substitutions + +.. |PreferencesHelper| replace:: :class:`~apptools.preferences.preferences_helper.PreferencesHelper` +.. |ScopedPreferences| replace:: :class:`~apptools.preferences.scoped_preferences.ScopedPreferences` diff --git a/docs/source/scripting/introduction.rst b/docs/source/scripting/introduction.rst index a13dbaf3d..724a2767d 100644 --- a/docs/source/scripting/introduction.rst +++ b/docs/source/scripting/introduction.rst @@ -16,8 +16,8 @@ This package is not just a toy framework and is powerful enough to provide full script recording to the Mayavi_ application. Mayavi is a powerful 3D visualization tool that is part of ETS_. -.. _Mayavi: http://code.enthought.com/projects/mayavi -.. _ETS: http://code.enthought.com/projects/tool-suite.php +.. _Mayavi: https://docs.enthought.com/mayavi/mayavi/ +.. _ETS: https://docs.enthought.com/ets/ .. _scripting-api: From 3817402271f6c4636db745e7a784fc737ddba115 Mon Sep 17 00:00:00 2001 From: Aaron Ayres Date: Wed, 9 Dec 2020 14:57:59 -0600 Subject: [PATCH 2/2] add a news fragment --- docs/releases/upcoming/248.doc.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/releases/upcoming/248.doc.rst diff --git a/docs/releases/upcoming/248.doc.rst b/docs/releases/upcoming/248.doc.rst new file mode 100644 index 000000000..6c0255d3b --- /dev/null +++ b/docs/releases/upcoming/248.doc.rst @@ -0,0 +1 @@ +Fix a few broken links in the documentation (#248) \ No newline at end of file