Commit eb71a93f authored by Matteo's avatar Matteo
Browse files

add sphix documentation

parent 0edb0fa4
# 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)
@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
# 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
project = 'MPAI CAE-ARP API'
copyright = '2023, Matteo Spanio'
author = 'Matteo Spanio'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = []
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster'
html_static_path = ['_static']
.. MPAI CAE-ARP API documentation master file, created by
sphinx-quickstart on Tue Apr 4 09:53:09 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to MPAI CAE-ARP API's documentation!
============================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
This diff is collapsed.
[tool.poetry] [tool.poetry]
name = "mpai-cae-arp" name = "mpai-cae-arp"
version = "0.1.0" version = "0.1.0"
description = "" description = "The MPAI CAE-ARP software API"
authors = ["Matteo <spartacus990@gmail.com>"] authors = ["Matteo Spanio <matteo.spanio97@gmail.com>"]
readme = "README.md" readme = "README.md"
packages = [{include = "mpai_cae_arp"}] packages = [{include = "mpai_cae_arp"}]
...@@ -11,6 +11,8 @@ python = "^3.10" ...@@ -11,6 +11,8 @@ python = "^3.10"
numpy = "1.23.3" numpy = "1.23.3"
pydantic = "^1.10.7" pydantic = "^1.10.7"
pyyaml = "^6.0" pyyaml = "^6.0"
llvmlite = "^0.39.1"
librosa = "^0.10.0.post2"
[tool.poetry.group.dev.dependencies] [tool.poetry.group.dev.dependencies]
pylint = "^2.17.2" pylint = "^2.17.2"
...@@ -20,6 +22,10 @@ pytest-cov = "^4.0.0" ...@@ -20,6 +22,10 @@ pytest-cov = "^4.0.0"
pytest-xdist = "^3.2.1" pytest-xdist = "^3.2.1"
toml = "^0.10.2" toml = "^0.10.2"
[tool.poetry.group.docs.dependencies]
sphinx = "^6.1.3"
[build-system] [build-system]
requires = ["poetry-core"] requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api" build-backend = "poetry.core.masonry.api"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment