RTD: wip

.gitignore

@@ -1,10 +1,11 @@
-.idea/
-.numba/
-__pycache__/
-dist/
-venv*/
-.venv*/
+.coverage
+.idea
+.numba
+__pycache__
+dist
+venv*
+.venv*
 profile.pstats
-NUCS.egg-info/
+NUCS.egg-info
 TODO.md
-ROADMAP.md
+

.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/source/conf.py

DOCUMENTATION.md

@@ -72,7 +72,7 @@ Python, with the help of lists and ranges, makes the construction of complex pro
 Internally, for greater efficiency, shared domains, domain indices and offsets are stored using `numpy.ndarray`.
 
 ##### A concrete example: the 4-queens problem
-![4-queens image](./assets/queens.png "4 non attacking queens")
+![4-queens image](assets/queens.png "4 non attacking queens")
 
 The 4-queens problem can be modelled as follows:
 - for **i** in **[0, 3]**, **v_i** is the vertical position of the queen in the **i**th column

README.md

@@ -1,6 +1,6 @@
 ![pypi version](https://img.shields.io/pypi/v/nucs?color=blue&label=pypi%20version&logo=pypi&logoColor=white)
-![numba version](https://img.shields.io/badge/numba-0.60-blue)
-![numpy version](https://img.shields.io/badge/numpy-2.0-blue)
+![numba version](https://img.shields.io/badge/numba-v0.60-blue)
+![numpy version](https://img.shields.io/badge/numpy-v2.0-blue)
 ![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)
 ![license](https://img.shields.io/github/license/yangeorget/nucs)
 

docs/Makefile

@@ -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     = source
+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)

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1

docs/source/api.rst

@@ -0,0 +1,7 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   lumache

docs/source/conf.py

@@ -0,0 +1,35 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'NUCS'
+copyright = '2024, Yan Georget'
+author = 'Yan Georget'
+
+release = '0.7'
+version = '0.7.1'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

docs/source/index.rst

@@ -0,0 +1,22 @@
+Welcome to Lumache's documentation!
+===================================
+
+**Lumache** (/lu'make/) is a Python library for cooks and food lovers
+that creates recipes mixing random ingredients.
+It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_
+and offers a *simple* and *intuitive* API.
+
+Check out the :doc:`usage` section for further information, including
+how to :ref:`installation` the project.
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+
+   usage
+   api

docs/source/usage.rst

@@ -0,0 +1,33 @@
+Usage
+=====
+
+.. _installation:
+
+Installation
+------------
+
+To use Lumache, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install lumache
+
+Creating recipes
+----------------
+
+To retrieve a list of random ingredients,
+you can use the ``lumache.get_random_ingredients()`` function:
+
+.. autofunction:: lumache.get_random_ingredients
+
+The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
+or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
+will raise an exception.
+
+.. autoexception:: lumache.InvalidKindError
+
+For example:
+
+>>> import lumache
+>>> lumache.get_random_ingredients()
+['shells', 'gorgonzola', 'parsley']

requirements-dev.txt

@@ -1,5 +1,6 @@
 black==24.2.0
 build==1.2.1
+coverage==7.6.1
 flake8==7.0.0
 isort==5.13.2
 mypy==1.9.0