documentation partially done

TRR318 · Aug 8, 2023 · af3671b · af3671b
1 parent 4ef7f26
commit af3671b
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 14 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /.idea
 /dist
 
-poetry.lock
+poetry.lock
+/docs/_build/
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep
diff --git a/docs/_templates/.gitkeep b/docs/_templates/.gitkeep
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,12 @@
+
+
+API
+===
+
+.. automodule:: skpsl
+   :members:
+   :undoc-members:
+
+.. autoclass:: skpsl.ProbabilisticScoringList
+   :members:
+   :undoc-members:
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
@@ -7,22 +7,24 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'Probabilistic Scoring List classifier'
-copyright = '2023, Jonas Hanselle, Stefan Heid'
-author = 'Jonas Hanselle, Stefan Heid'
+copyright = '2023, "Stefan Heid <[email protected]>", "Jonas Hanselle <[email protected]>"'
+author = '"Stefan Heid <[email protected]>", "Jonas Hanselle <[email protected]>"'
 release = '0.1.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = ['sphinx_rtd_theme',
+              'sphinx.ext.todo',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.autodoc']
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_theme_path = ["_themes", ]
+html_static_path = ['_static']
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
@@ -1,5 +1,5 @@
 .. Probabilistic Scoring List classifier documentation master file, created by
-   sphinx-quickstart on Tue Aug  8 10:24:11 2023.
+   sphinx-quickstart on Tue Aug  8 13:43:26 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
@@ -10,7 +10,7 @@ Welcome to Probabilistic Scoring List classifier's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-
+   api.rst
 
 Indices and tables
 ==================

diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,13 +14,18 @@ python = ">=3.9,<3.13"
 scikit-learn = "^1.3.0"
 numpy = "^1.25.2"
 scipy = "^1.11.1"
+
 sphinx = { version = "^7.1", optional = true }
-sphinx_rtd_theme = { version = "^0.4.3", optional = true  }
+sphinx_rtd_theme = { version = "^1.2", optional = true  }
+
+pytest = { version = "^7.4", optional = true }
+
 
 [tool.poetry.extras]
-docs = ["sphinx", "sphinx_rtd_theme"]
+doc = ["sphinx", "sphinx_rtd_theme"]
+test = ["pytest"]
 
 
 [build-system]
 requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+build-backend = "poetry.core.masonry.api"
diff --git a/skpsl/probabilistic_scoring_list.py b/skpsl/probabilistic_scoring_list.py
@@ -67,7 +67,8 @@ def _relevant_scores(self, X):
 
 class ProbabilisticScoringList(BaseEstimator, ClassifierMixin):
     """
-    Probabilistic scoring list classifier. A probabilistic classifier that greedily creates a PSL selecting one feature at a time
+    Probabilistic scoring list classifier.
+    A probabilistic classifier that greedily creates a PSL selecting one feature at a time
     """
 
     def __init__(self, score_set, entropy_threshold=-1):