docs: cleanup and minor fixes

RI-imaging · Jul 16, 2018 · 872da74 · 872da74
1 parent c356816
commit 872da74
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 15 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,7 +15,7 @@ documentation of qpformat version |release|.
    sec_getting_started
    sec_examples
    sec_code_reference
-   z_bib
+   sec_z_bib
 
 
 Indices and tables

diff --git a/docs/sec_code_reference.rst b/docs/sec_code_reference.rst
@@ -15,20 +15,19 @@ file format base classes
 ========================
 SeriesData
 ----------
-.. autoclass:: qpformat.file_formats.dataset.SeriesData
+.. autoclass:: qpformat.file_formats.SeriesData
     :members:
 
 SingleData
 ----------
-.. autoclass:: qpformat.file_formats.dataset.SingleData
+.. autoclass:: qpformat.file_formats.SingleData
     :inherited-members:
 
 
-
 file format readers
 ===================
-All file formats inherit from :class:`qpformat.file_formats.dataset.SeriesData`
-(and/or :class:`qpformat.file_formats.dataset.SingleData`).
+All file formats inherit from :class:`qpformat.file_formats.SeriesData`
+(and/or :class:`qpformat.file_formats.SingleData`).
 
 .. autodoc_qpformats::
 
@@ -37,4 +36,4 @@ exceptions
 ==========
 .. autoexception:: qpformat.file_formats.MultipleFormatsNotSupportedError
 
-.. autoexception:: qpformat.file_formats.UnknownFileFormatError
+.. autoexception:: qpformat.file_formats.UnknownFileFormatError
diff --git a/docs/sec_getting_started.rst b/docs/sec_getting_started.rst
@@ -5,5 +5,5 @@ Getting started
 .. toctree::
   :maxdepth: 2
 
-  installation
-  userapi
+  sec_installation
+  sec_userapi
diff --git a/docs/installation.rst → docs/sec_installation.rst b/docs/installation.rst → docs/sec_installation.rst
diff --git a/docs/sec_introduction.rst b/docs/sec_introduction.rst
@@ -18,7 +18,7 @@ from its hdf5-based data structure (e.g. elaborate background correction,
 meta data management, and transparent data storage). Furthermore, qpformat
 can manage large datasets (e.g. many holograms in one folder) without running
 out of memory by means of its lazily-evaluated
-:class:`SeriesData <qpformat.file_formats.SeriesData` class.
+:class:`SeriesData <qpformat.file_formats.SeriesData>` class.
 
 
 .. _supported_formats:

diff --git a/docs/userapi.rst → docs/sec_userapi.rst b/docs/userapi.rst → docs/sec_userapi.rst
@@ -1,16 +1,15 @@
 ========
 User API
 ========
-Qpformat supports several file formats
-(:py:class:`qpformat.file_formats.formats`), which are
-divided into :py:class:`qpformat.file_formats.SingleData`
+Qpformat supports :ref:`several file formats <supported_formats>` that are
+categorized into :class:`qpformat.file_formats.SingleData`
 (the experimental data file format contains only one phase image)
-and :py:class:`qpformat.file_formats.SeriesData` (the experimental
+and :class:`qpformat.file_formats.SeriesData` (the experimental
 data file format supports multiple phase images).
 From these base classes, all data file formats are derived. The idea
 is that experimental data is not loaded into memory until the
 `get_qpimage` method is called which returns a
-:py:class:`qpimage.QPImage` object.
+:class:`qpimage.QPImage <qpimage.core.QPImage>` object.
 
 Basic Usage
 -----------

diff --git a/docs/z_bib.rst → docs/sec_z_bib.rst b/docs/z_bib.rst → docs/sec_z_bib.rst
diff --git a/qpformat/file_formats/__init__.py b/qpformat/file_formats/__init__.py
@@ -3,6 +3,7 @@
 import pathlib
 
 from .dataset import SeriesData, hash_obj
+from .dataset import SingleData  # noqa:F401 (user convenience)
 from .series_hdf5_hyperspy import SeriesHdf5HyperSpy
 from .series_hdf5_qpimage import SeriesHdf5Qpimage
 from .series_zip_tif_holo import SeriesZipTifHolo