From 55b9a75909ac147df3063e41731dd95dc8b0288a Mon Sep 17 00:00:00 2001 From: Paul McCarthy <pauld.mccarthy@gmail.com> Date: Tue, 26 Jan 2016 16:56:31 +0000 Subject: [PATCH] Doc files for some newer modules. There are probably more that I'm missing. --- .../fsl.fsleyes.controls.melodicclassificationgrid.rst | 9 +++++++++ .../fsl.fsleyes.controls.melodicclassificationpanel.rst | 9 +++++++++ apidoc/fsl.fsleyes.perspectives.rst | 9 +++++++++ apidoc/fsl.utils.memoize.rst | 9 +++++++++ apidoc/fsl.utils.notifier.rst | 9 +++++++++ apidoc/fsl.utils.status.rst | 9 +++++++++ fsl/fsleyes/perspectives.py | 4 ++-- 7 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 apidoc/fsl.fsleyes.controls.melodicclassificationgrid.rst create mode 100644 apidoc/fsl.fsleyes.controls.melodicclassificationpanel.rst create mode 100644 apidoc/fsl.fsleyes.perspectives.rst create mode 100644 apidoc/fsl.utils.memoize.rst create mode 100644 apidoc/fsl.utils.notifier.rst create mode 100644 apidoc/fsl.utils.status.rst diff --git a/apidoc/fsl.fsleyes.controls.melodicclassificationgrid.rst b/apidoc/fsl.fsleyes.controls.melodicclassificationgrid.rst new file mode 100644 index 000000000..875a53aed --- /dev/null +++ b/apidoc/fsl.fsleyes.controls.melodicclassificationgrid.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.fsleyes.controls.melodicclassificationgrid module +===================================================== + +.. automodule:: fsl.fsleyes.controls.melodicclassificationgrid + :members: + :undoc-members: + :show-inheritance: diff --git a/apidoc/fsl.fsleyes.controls.melodicclassificationpanel.rst b/apidoc/fsl.fsleyes.controls.melodicclassificationpanel.rst new file mode 100644 index 000000000..02e4bff26 --- /dev/null +++ b/apidoc/fsl.fsleyes.controls.melodicclassificationpanel.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.fsleyes.controls.melodicclassificationpanel module +====================================================== + +.. automodule:: fsl.fsleyes.controls.melodicclassificationpanel + :members: + :undoc-members: + :show-inheritance: diff --git a/apidoc/fsl.fsleyes.perspectives.rst b/apidoc/fsl.fsleyes.perspectives.rst new file mode 100644 index 000000000..10634c4c3 --- /dev/null +++ b/apidoc/fsl.fsleyes.perspectives.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.fsleyes.perspectives module +=============================== + +.. automodule:: fsl.fsleyes.perspectives + :members: + :undoc-members: + :show-inheritance: diff --git a/apidoc/fsl.utils.memoize.rst b/apidoc/fsl.utils.memoize.rst new file mode 100644 index 000000000..42519daa6 --- /dev/null +++ b/apidoc/fsl.utils.memoize.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.utils.memoize module +======================== + +.. automodule:: fsl.utils.memoize + :members: + :undoc-members: + :show-inheritance: diff --git a/apidoc/fsl.utils.notifier.rst b/apidoc/fsl.utils.notifier.rst new file mode 100644 index 000000000..32f231ea8 --- /dev/null +++ b/apidoc/fsl.utils.notifier.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.utils.notifier module +========================= + +.. automodule:: fsl.utils.notifier + :members: + :undoc-members: + :show-inheritance: diff --git a/apidoc/fsl.utils.status.rst b/apidoc/fsl.utils.status.rst new file mode 100644 index 000000000..2ab0edfd9 --- /dev/null +++ b/apidoc/fsl.utils.status.rst @@ -0,0 +1,9 @@ +:orphan: + +fsl.utils.status module +======================= + +.. automodule:: fsl.utils.status + :members: + :undoc-members: + :show-inheritance: diff --git a/fsl/fsleyes/perspectives.py b/fsl/fsleyes/perspectives.py index 5185c1a79..27b583bf3 100644 --- a/fsl/fsleyes/perspectives.py +++ b/fsl/fsleyes/perspectives.py @@ -30,8 +30,8 @@ too: A perspective defines a layout for a :class:`.FSLEyesFrame`. It specifies the type and layout of one or more *views* (defined in the :mod:`.views` module) and, within each view, the type and layout of one or more *controls* (defined -in the :mod:`.controls` module). See the :mod:`.fsleyes` documentation for an -overview of views and controls. +in the :mod:`.controls` module). See the :mod:`~fsl.fsleyes` documentation for +an overview of views and controls. All of this information is stored as a string - see the -- GitLab