Modernized docs. Work in progress.

.readthedocs.yml

@@ -1,13 +1,13 @@
-version: 2
-formats:
-  - pdf
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
-    - method: setuptools
-      path: .
+
 sphinx:
-  builder: html
-  configuration: docs/conf.py
-  fail_on_warning: false
+  configuration: docs/source/conf.py

docs/Makefile

@@ -3,9 +3,9 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=-vvv
+SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = ../miceforest
+SOURCEDIR     = .
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

docs/conf.py

@@ -1,113 +1,27 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
+# For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
-import sys
-import sphinx
-from sphinx.errors import VersionRequirementError
-
-sys.path.insert(0, os.path.abspath(".."))
-
-
 # -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "miceforest"
-copyright = "2021, Samuel Von Wilson"
-author = "Samuel Von Wilson"
-
-# The full version, including alpha/beta/rc tags
-release = "2021-08-21"
-
-# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "4.2.0"  # Due to sphinx.ext.napoleon, autodoc_typehints
-if needs_sphinx > sphinx.__version__:
-    message = f"This project needs at least Sphinx v{needs_sphinx}"
-    raise VersionRequirementError(message)
+project = 'miceforest'
+copyright = '2024, Samuel Von Wilson'
+author = 'Samuel Von Wilson'
 
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.todo",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.napoleon",
-]
-
-autodoc_default_flags = ["members", "inherited-members", "show-inheritance"]
-autodoc_default_options = {
-    "members": True,
-    "inherited-members": True,
-    "show-inheritance": True,
-}
-
-# mock out modules
-autodoc_mock_imports = [
-    "matplotlib",
-    "seaborn",
-    "numpy",
-    "pandas",
-    "scipy",
-    "scikit-learn",
-    "lightgbm",
-]
+extensions = ["myst_parser"]
 
-master_doc = "index"
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# hide type hints in API docs
-autodoc_typehints = "none"
-
-# Only the class' docstring is inserted.
-autoclass_content = "class"
-
-# Generate autosummary pages.
-autosummary_generate = [
-    "ImputationKernel.rst",
-    "ImputedData.rst",
-    "utils.rst",
-    "MeanMatchScheme.rst",
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-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
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = "sphinx_rtd_theme"
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-html_theme_options = {
-    "includehidden": False,
-    "logo_only": True,
-}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
-
-def setup(app):
-    app.add_css_file("themes.css")
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/index.rst

@@ -1,40 +1,17 @@
 .. miceforest documentation master file, created by
-   sphinx-quickstart on Tue Dec 28 11:24:49 2021.
+   sphinx-quickstart on Sat Jul 27 20:34:30 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. image:: ./logo/icon_small.png
-   :align: right
-   :width: 250
-   :alt: miceforest logo.
+miceforest documentation
+========================
 
-Welcome to miceforest's documentation!
-======================================
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
 
-``miceforest`` imputes missing data using LightGBM in an iterative method known as Multiple Imputation by Chained Equations (MICE). It was designed to be:
-
-* **Fast**
-   * Uses lightgbm as a backend
-   * Has efficient mean matching solutions.
-   * Can utilize GPU training
-* **Flexible**
-   * Can impute pandas dataframes and numpy arrays
-   * Handles categorical data automatically
-   * Fits into a sklearn pipeline
-   * User can customize every aspect of the imputation process
-* **Production Ready**
-   * Can impute new, unseen datasets very quickly
-   * Kernels are efficiently compressed during saving and loading
-   * Data can be imputed in place to save memory
-   * Can build models on non-missing data
-
-There are very extensive `beginner <https://github.com/AnotherSamWilson/miceforest#The-Basics>`_ and `advanced <https://github.com/AnotherSamWilson/miceforest#Advanced-Features>`_ tutorials on the github readme. Below is a table of contents for the topics covered:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
 
-   ImputationKernel
-   ImputedData
-   MeanMatchScheme
-   utils