doc and install

README.md

@@ -0,0 +1,47 @@
+Optifik version 0.1.0
+
+
+# Installation
+
+The use of pip must be limited to virtualenv
+
+
+* From PyPI
+```
+pip install optifik
+```
+
+* From tarball
+```
+pip install /chemin/vers/optifik-0.1.0.tar.gz
+```
+
+* From the source code
+```
+pip install .
+```
+
+
+# For contributors
+
+* Install an editable version
+```
+pip install -e .
+```
+
+* Install dev tools
+```
+pip install -e ".[dev]"
+```
+
+* Install doc tools
+```
+pip install -e ".[docs]"
+```
+
+* Build the doc
+```
+cd docs
+make html
+```
+

docs/conf.py

@@ -19,10 +19,17 @@ author = 'F. Boulogne et al.'
 
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'numpydoc',  # Doit être après 'autodoc'
+    'myst_parser',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
 ]
 
+numpydoc_show_inherited_class_members = True
+numpydoc_use_plots = False  # Plots in doctring
+numpydoc_class_members_toctree = False
+
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 

optifik/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

pyproject.toml

@@ -15,6 +15,31 @@ dependencies = [
   "matplotlib>=1.3.1",
 ]
 
+[tool.setuptools]
+packages = ["optifik"]
+
+
+[tool.bumpver]
+current_version = "0.1.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit = true
+tag = true
+push = false
+
+
+[bumpver.file_patterns]
+"pyproject.toml" = [
+    'current_version = "{version}"',
+]
+"optifik/__init__.py" = [
+    'version="{pep440_version}",',
+]
+"README.md" = [
+    '{version}',
+    '{pep440_version}',
+]
+
+
 
 [project.urls]
 Homepage = "https://github.com/votrecompte/votreprojet"
@@ -22,13 +47,23 @@ Documentation = "https://github.com/votrecompte/votreprojet#readme"
 Repository = "https://github.com/sciunto-org/optifik"
 Issues = "https://github.com/sciunto-org/optifik/issues"
 
-[tool.setuptools]
-packages = ["optifik"]
 
 [project.optional-dependencies]
 dev = [
   "pytest",
-  "pytest-cov"
+  "pytest-cov",
+  "bumpver"
+]
+
+docs = [
+  "sphinx>=7.0",
+  "sphinx-rtd-theme>=2.0",
+  "numpydoc>=1.6",
+  "myst-parser>=2.0",  # Markdown + reStructuredText
+  "sphinx-autodoc-typehints>=2.0",
+  "sphinx-copybutton>=0.5",
+  "sphinx-design>=0.5",
+  #"matplotlib>=3.0", # For plots in docstring
 ]
 
 [tool.setuptools.package-data]