diff --git a/.gitignore b/.gitignore index 6cffd96..9bf7747 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ scratch/ *.egg *.fcs *.egg-info +/docs/_build/* diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3d5b871 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +python: + install: + - requirements: docs/requirements.txt + +sphinx: + configuration: docs/conf.py diff --git a/docs/api.rst b/docs/api.rst index 85f5be5..5696c9a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,26 +1,24 @@ +.. currentmodule:: flowio + FlowIO API =================================== -FlowIO includes a single FlowData class for reading existing FCS files and -a :code:`create_fcs` function for creating new FCS files. - FlowData Class -------------- -.. autoclass:: flowio.FlowData +.. autoclass:: FlowData :members: + Reading FCS Files with Multiple Data Sets ----------------------------------------- -.. automodule:: flowio.read_multiple_data_sets - :members: +.. autofunction:: read_multiple_data_sets Creating New FCS Files ---------------------- -.. automodule:: flowio.create_fcs - :members: +.. autofunction:: create_fcs FlowIO Exceptions ----------------- diff --git a/docs/conf.py b/docs/conf.py index 9602971..b281d14 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,7 +12,7 @@ if on_rtd: sys.path.insert(0, os.path.abspath('..')) else: - sys.path.insert(0, os.path.abspath('../..')) + sys.path.insert(0, os.path.abspath('..')) class Mock(MagicMock): diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..5437b18 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +Sphinx>=3 diff --git a/flowio/__init__.py b/flowio/__init__.py index 4e925b5..f01559a 100644 --- a/flowio/__init__.py +++ b/flowio/__init__.py @@ -1,4 +1,13 @@ from .flowdata import FlowData from .create_fcs import create_fcs from .utils import read_multiple_data_sets +from . import exceptions as exceptions # noqa + from ._version import __version__ + +__all__ = [ + 'FlowData', + 'create_fcs', + 'read_multiple_data_sets', + 'exceptions' +] diff --git a/flowio/_version.py b/flowio/_version.py index 9bff36f..ad194f9 100644 --- a/flowio/_version.py +++ b/flowio/_version.py @@ -1,4 +1,4 @@ """ FlowIO version """ -__version__ = "1.2.0b0" +__version__ = "1.2.0"