Commit 1d4178bf authored by Paul McCarthy's avatar Paul McCarthy
Browse files

Documentation tweaks. Also hard-coded current version number.

parent 04099941
......@@ -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'
......@@ -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
......@@ -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.
: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
......@@ -104,7 +104,6 @@ class Instanceify(object):
can be applied to instance methods. For example, say we have the following
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):
......@@ -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. """
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment