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.

Sign up for GitHub

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

fix a few broken links in documentation #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
083ef2f
fix a few broken links in documentation
aaronayres35 Dec 9, 2020
3817402
add a news fragment
aaronayres35 Dec 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/releases/upcoming/248.doc.rst
View file
Open in desktop
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
View file
Open in desktop
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`
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.

4 changes: 2 additions & 2 deletions docs/source/scripting/introduction.rst
View file
Open in desktop
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