Skip to content

Commit

Permalink
fix a few broken links in documentation (#248)
Browse files Browse the repository at this point in the history
* fix a few broken links in documentation

* add a news fragment
  • Loading branch information
aaronayres35 authored Dec 10, 2020
1 parent 4f4178c commit 764b722
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/releases/upcoming/248.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a few broken links in the documentation (#248)
11 changes: 7 additions & 4 deletions docs/source/preferences/PreferencesInEnvisage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand All @@ -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()
Expand All @@ -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`
4 changes: 2 additions & 2 deletions docs/source/scripting/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 764b722

Please sign in to comment.