Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
24 changes: 24 additions & 0 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/* Custom header sizes */
h1 {
font-size: 1.85em;
}

h2 {
font-size: 1.55em;
}

h3 {
font-size: 1.30em;
}

h4 {
font-size: 1.10em;
}

h5 {
font-size: 0.90em;
}

img.sidebar-logo {
width: 40px;
}
14 changes: 14 additions & 0 deletions docs/array/histogram/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
======================
khisto.array.histogram
======================

.. automodule:: khisto.array.histogram

Main Modules
============
.. autosummary::
:toctree: generated
:recursive:
:nosignatures:

api
101 changes: 101 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import os
import sys
from pathlib import Path

sys.path.append("..")
sys.path.append(os.path.join("..", "src"))

project = 'khisto-python'
copyright = '2026, The Khiops Team'
author = 'The Khiops Team'
release = "0.1.0" # TODO: use pyproject metadata here

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
# Be strict about any broken references
nitpicky = True

# To avoid using qualifiers like :class: to reference objects within the same context
default_role = "obj"

extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx",
"numpydoc",
"sphinx_copybutton",
]

## Numpydoc extension config
numpydoc_show_class_members = False

## Autodoc extension config
autodoc_default_options = {
"members": True,
"inherited-members": False,
"private-members": False,
"show-inheritance": True,
"special-members": False,
}

## Intersphinx extension config
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable", None),
"matplotlib": ("https://matplotlib.org/stable", None),
}

templates_path = ['_templates']
exclude_patterns = ['_templates', '_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 = 'furo'
html_theme_options = {
"light_css_variables": {
"color-brand-primary": "#FF7900",
"color-brand-content": "#F16E00",
"color-brand-visited": "#FF7900",
"color-sidebar-background": "#FFFFFF",
"color-highlighted-background": "#FFD200",
"color-admonition-title--note": "#FF7900",
"color-admonition-title-background--note": "#FFF0E2",
"font-stack": "Helvetica Neue, Helvetica, sans-serif",
},
"dark_css_variables": {
"color-brand-primary": "#FF7900",
"color-brand-content": "#F16E00",
"color-brand-visited": "#FF7900",
"color-sidebar-background": "#000000",
"color-highlighted-background": "#FFD200",
"color-admonition-title--note": "#FF7900",
"color-admonition-title-background--note": "#CC6100",
"font-stack": "Helvetica Neue, Helvetica, sans-serif",
},
# Sets the Github Icon (the SVG is embedded, copied from furo's repo)
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/khiopsml/khisto-python",
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
</svg>
""",
"class": "",
},
],
}
html_title = f"<h6><center>{project} {release}</center></h6>"
html_static_path = ['_static']
html_css_files = ["css/custom.css"]
14 changes: 14 additions & 0 deletions docs/core/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
============
khisto.core
============

.. automodule:: khisto.core

Main Modules
============
.. autosummary::
:toctree: generated
:recursive:
:nosignatures:

cli_adapter
22 changes: 22 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. khisto-python documentation master file, created by
sphinx-quickstart on Fri Mar 6 17:40:33 2026.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

khisto-python documentation
===========================

Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.


.. toctree::
:maxdepth: 2
:caption: API Reference
:hidden:

Histograms <array/histogram/index>
Core <core/index>
Matplotlib <matplotlib/index>

35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
14 changes: 14 additions & 0 deletions docs/matplotlib/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
=================
khisto.matplotlib
=================

.. automodule:: khisto.matplotlib

Main Modules
============
.. autosummary::
:toctree: generated
:recursive:
:nosignatures:

hist
2 changes: 1 addition & 1 deletion src/khisto/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

KHISTO_BIN_DIR = os.environ.get("KHISTO_BIN_DIR", "khisto")

__version__ = version("khisto")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not get the version from the pyproject toml ?

__version__ = "0.1.0"

from .array import histogram # noqa: E402
from .core import HistogramResult # noqa: E402
Expand Down