From 1d4178bf77d6284a2285ca59f1e1b368f8e4371a Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Tue, 8 Mar 2016 17:05:25 +0000
Subject: [PATCH] Documentation tweaks. Also hard-coded current version number.
---
apidoc/conf.py | 9 +++++----
fsl/fsleyes/gl/wxglslicecanvas.py | 2 +-
fsl/utils/dialog.py | 6 +++---
fsl/utils/memoize.py | 3 +--
fsl/version.py | 4 ++--
5 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/apidoc/conf.py b/apidoc/conf.py
index 6a29f73e2..ff39e3029 100644
--- a/apidoc/conf.py
+++ b/apidoc/conf.py
@@ -63,10 +63,11 @@ copyright = u'{}, Paul McCarthy, FMRIB Centre'.format(date.year)
# built documents.
#
# The short X.Y version.
-import fsl
-version = fsl.__version__
+import fsl.version as fslversion
+version = fslversion.__version__
+
# The full version, including alpha/beta/rc tags.
-release = version
+release = '{} ({})'.format(version, fslversion.__vcs_version__)
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -277,7 +278,7 @@ texinfo_documents = [
epub_title = u'FSLpy'
epub_author = u'Paul McCarthy'
epub_publisher = u'Paul McCarthy'
-epub_copyright = u'{}, Paul McCarthy'.format(date.year)
+epub_copyright = u'{}, Paul McCarthy, FMRIB Centre, Oxford'.format(date.year)
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'FSLpy'
diff --git a/fsl/fsleyes/gl/wxglslicecanvas.py b/fsl/fsleyes/gl/wxglslicecanvas.py
index 4964630fa..d56f5dd0e 100644
--- a/fsl/fsleyes/gl/wxglslicecanvas.py
+++ b/fsl/fsleyes/gl/wxglslicecanvas.py
@@ -51,7 +51,7 @@ class WXGLSliceCanvas(slicecanvas.SliceCanvas,
displayed on the canvas seems to persist, does not get overridden, and
gets drawn on top of other things in the interface:
- .. image:: images/x11_slicecanvas_bug.png
+ .. image:: images/x11_slicecanvas_show_bug.png
:scale: 50%
:align: center
diff --git a/fsl/utils/dialog.py b/fsl/utils/dialog.py
index 92ff78d09..f922d06d1 100644
--- a/fsl/utils/dialog.py
+++ b/fsl/utils/dialog.py
@@ -710,7 +710,7 @@ class FSLDirDialog(wx.Dialog):
class CheckBoxMessageDialog(wx.Dialog):
"""A ``wx.Dialog`` which displays a message, a ``wx.CheckBox``, and
- an "Ok" button.
+ an *Ok* button.
"""
@@ -735,13 +735,13 @@ class CheckBoxMessageDialog(wx.Dialog):
:arg cbState: Initial state for the ``wx.CheckBox``.
- :arg btnText: Text to show on the button. Defaults to "OK".
+ :arg btnText: Text to show on the button. Defaults to *OK*.
:arg icon: A ``wx`` icon identifier (e.g.
``wx.ICON_EXCLAMATION``).
:arg style: Passed through to the ``wx.Dialog.__init__`` method.
- Defaults to ``wx.DEFAULT_DIALOG_STYLE`.
+ Defaults to ``wx.DEFAULT_DIALOG_STYLE``.
"""
if style is None: style = wx.DEFAULT_DIALOG_STYLE
diff --git a/fsl/utils/memoize.py b/fsl/utils/memoize.py
index bc4de7596..07f6f1242 100644
--- a/fsl/utils/memoize.py
+++ b/fsl/utils/memoize.py
@@ -104,7 +104,6 @@ class Instanceify(object):
can be applied to instance methods. For example, say we have the following
class::
-
class Container(object):
def __init__(self):
@@ -121,7 +120,7 @@ class Instanceify(object):
be associated with a single ``Container`` instance.
- By redefining the ``Container`` class definition like so:
+ By redefining the ``Container`` class definition like so::
class Container(object):
diff --git a/fsl/version.py b/fsl/version.py
index 344837558..78d9ac142 100644
--- a/fsl/version.py
+++ b/fsl/version.py
@@ -15,9 +15,9 @@ version number and information.
.. todo:: Define a formal ``fslpy`` version number updating scheme.
"""
-__version__ = '0.1'
+__version__ = '0.9a'
"""Current version number, as a string. """
-__vcs_version__ = 'abc'
+__vcs_version__ = '0.9a'
"""VCS (Version Control System) version number, for internal use. """
--
GitLab