adding template to docs

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/leeme.txt

@@ -0,0 +1,10 @@
+Para meter los módulos dentro de doc hay que hacer un
+
+sphinx-apidoc -o docs/source/ quapy/ -P
+
+Eso importa todo lo que haya en quapy/ (incluidos los ficheros _ gracias a -P) en source y crea un rst para cada uno.
+
+Parece que lo del -P no funciona. Hay que meterlos a mano en quapy.method.rst
+
+Luego, simplemente
+make html

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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

docs/source/index.rst

@@ -0,0 +1,41 @@
+.. QuaPy: A Python-based open-source framework for quantification documentation master file, created by
+   sphinx-quickstart on Wed Feb  7 16:26:46 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to QuaPy's documentation!
+==========================================================================================
+
+QuaPy is a Python-based open-source framework for quantification.
+
+This document contains the API of the modules included in QuaPy.
+
+Installation
+------------
+
+`pip install quapy`
+
+GitHub
+------------
+
+QuaPy is hosted in GitHub at `https://github.com/HLT-ISTI/QuaPy <https://github.com/HLT-ISTI/QuaPy>`_
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Contents
+--------
+
+.. toctree::
+
+   modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+quapy
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   quapy

docs/source/quapy.classification.rst

@@ -0,0 +1,45 @@
+quapy.classification package
+============================
+
+Submodules
+----------
+
+quapy.classification.calibration module
+---------------------------------------
+
+.. automodule:: quapy.classification.calibration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.classification.methods module
+-----------------------------------
+
+.. automodule:: quapy.classification.methods
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.classification.neural module
+----------------------------------
+
+.. automodule:: quapy.classification.neural
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.classification.svmperf module
+-----------------------------------
+
+.. automodule:: quapy.classification.svmperf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quapy.classification
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quapy.data.rst

@@ -0,0 +1,46 @@
+quapy.data package
+==================
+
+Submodules
+----------
+
+quapy.data.base module
+----------------------
+
+.. automodule:: quapy.data.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.data.datasets module
+--------------------------
+
+.. automodule:: quapy.data.datasets
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+quapy.data.preprocessing module
+-------------------------------
+
+.. automodule:: quapy.data.preprocessing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.data.reader module
+------------------------
+
+.. automodule:: quapy.data.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quapy.data
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quapy.method.rst

@@ -0,0 +1,61 @@
+quapy.method package
+====================
+
+Submodules
+----------
+
+quapy.method.aggregative module
+-------------------------------
+
+.. automodule:: quapy.method.aggregative
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: quapy.method._kdey
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: quapy.method._neural
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: quapy.method._threshold_optim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+quapy.method.base module
+------------------------
+
+.. automodule:: quapy.method.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.method.meta module
+------------------------
+
+.. automodule:: quapy.method.meta
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.method.non\_aggregative module
+------------------------------------
+
+.. automodule:: quapy.method.non_aggregative
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quapy.method
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quapy.rst

@@ -0,0 +1,80 @@
+quapy package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   quapy.classification
+   quapy.data
+   quapy.method
+
+
+Submodules
+----------
+
+quapy.error module
+------------------
+
+.. automodule:: quapy.error
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.evaluation module
+-----------------------
+
+.. automodule:: quapy.evaluation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.functional module
+-----------------------
+
+.. automodule:: quapy.functional
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.model\_selection module
+-----------------------------
+
+.. automodule:: quapy.model_selection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.plot module
+-----------------
+
+.. automodule:: quapy.plot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.protocol module
+---------------------
+
+.. automodule:: quapy.protocol
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quapy.util module
+-----------------
+
+.. automodule:: quapy.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quapy
+   :members:
+   :undoc-members:
+   :show-inheritance: