diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index 99fa777b..00000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,16 +0,0 @@ -version: 2 - -build: - os: ubuntu-20.04 - tools: - python: "3.9" - -sphinx: - configuration: docs/source/conf.py - -python: - install: - - method: pip - path: . - extra_requirements: - - doc diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d0c3cbf1..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# 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) diff --git a/notebooks/documentation.html b/docs/documentation.html similarity index 100% rename from notebooks/documentation.html rename to docs/documentation.html diff --git a/notebooks/documentation.ipynb b/docs/documentation.ipynb similarity index 100% rename from notebooks/documentation.ipynb rename to docs/documentation.ipynb diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 6fcf05b4..00000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%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 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index b17bac19..00000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,67 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('../../')) - - -# -- Project information ----------------------------------------------------- - -project = 'hplib' -copyright = '2022, RE-Lab-Projects' -author = 'RE-Lab-Projects' - -# The full version, including alpha/beta/rc tags -release = '0.7' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'myst_parser', - 'sphinx.ext.duration', - 'sphinx.ext.autosectionlabel', - 'sphinx.ext.autodoc', - 'nbsphinx', - 'autoapi.extension', - 'sphinx.ext.napoleon' -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'furo' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -autoapi_type = 'python' -autoapi_dirs = ['../../hplib'] - -autoclass_content='class' \ No newline at end of file diff --git a/docs/source/index.md b/docs/source/index.md deleted file mode 100644 index 35f466a4..00000000 --- a/docs/source/index.md +++ /dev/null @@ -1,17 +0,0 @@ -% hplib documentation master file, created by -% sphinx-quickstart on Mon May 9 10:19:32 2022. -% You can adapt this file completely to your liking, but it should at least -% contain the root `toctree` directive. - -# hplib documentation - -```{include} ../../README.md - -``` -For further info, check out {doc}`usage`. -Read installation instructions in {ref}`Installation`. - -```{toctree} -:caption: 'Contents:' -:maxdepth: 2 -``` diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 3864486a..00000000 --- a/pyproject.toml +++ /dev/null @@ -1,22 +0,0 @@ -[build-system] -requires = ['flit_core >=3.4,<4'] -build-backend = "flit_core.buildapi" - -[tool.pytest.ini_options] -addopts = "--cov=hplib" -testpaths = [ - "tests", -] - -[project] -name='hplib' -authors= [{name='RE-Lab-Projects', email = 're-lab-projects@hs-emden-leer.de'}] -dynamic=['version', 'description'] - -[project.optional-dependencies] -doc=[ - 'sphinx~=4.2.0', - 'myst-parser', - 'furo', - 'nbsphinx', -]