diff --git a/.gitignore b/.gitignore index 0a39e069..1f33ca7a 100644 --- a/.gitignore +++ b/.gitignore @@ -68,9 +68,6 @@ instance/ # Scrapy .scrapy -# Sphinx documentation -docs/_build/ - # PyBuilder target/ diff --git a/README.md b/README.md index a12e320a..58bb1e03 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@
-# Continuity +Continuity -Continuity +Mapping continuous functions with neural networks.
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/docs/README.md b/docs/README.md index 697da614..3dc60402 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,20 +1,16 @@ +# Documentation ## Steps to build documentation -1. Build and install package from source. +1. Install package from source and install dependencies. ```bash -cd ./continuity/ pip install -e . -pip install sphinx sphinx_book_theme sphinx_copybutton +pip install -r docs/requirements.txt ``` -2. Generate documentation from your docstrings. +2. Build documentation. ```bash -cd docs/ -sphinx-apidoc -f -o ./source ../src/continuity +mkdocs build ``` -3. Build the documentation -```bash -make clean && make html -``` -4. You can now view your documentation under `docs/build/html/index.html`. + +3. View your documentation opening `site/index.html`. diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 00000000..7885686c --- /dev/null +++ b/docs/about.md @@ -0,0 +1,2 @@ +About +========== diff --git a/docs/documentation.md b/docs/documentation.md new file mode 100644 index 00000000..773fec4f --- /dev/null +++ b/docs/documentation.md @@ -0,0 +1,4 @@ +Modules +======= + +::: continuity.data.dataset.DataSet diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico new file mode 100644 index 00000000..45ced1c1 Binary files /dev/null and b/docs/img/favicon.ico differ diff --git a/docs/img/logo.png b/docs/img/logo.png new file mode 100644 index 00000000..e4000a2a Binary files /dev/null and b/docs/img/logo.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..1233e9e2 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,4 @@ +Continuity +========== + +Mapping continuous functions with neural networks. diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 00000000..87884f72 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,8 @@ +Installation +============ + +``` +git clone https://github.com/aai-institute/Continuity.git +cd Continuity +pip install -e . +``` diff --git a/docs/requirements.txt b/docs/requirements.txt index 2e0e2c79..a839c60c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,2 @@ -myst-nb==0.13.2 -Sphinx==4.1.2 -sphinx-book-theme==0.3.2 -sphinx-copybutton>=0.5.0 +mkdocs +mkdocstrings diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png deleted file mode 100644 index 8c6036c2..00000000 Binary files a/docs/source/_static/logo.png and /dev/null differ diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index f2abb868..00000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,73 +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('.')) -from pathlib import Path - -# Add parent dir to known paths -p = Path(__file__).parents[2] -sys.path.insert(0, os.path.abspath(p)) - -# -- Project information ----------------------------------------------------- - -project = "Continuity" -copyright = "Samuel Burbulla 2023" -author = "Samuel Burbulla" - -# The full version, including alpha/beta/rc tags -release = "0.1" - - -# -- 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 = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.napoleon", - "sphinx_copybutton", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = "en" - -# 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 = "sphinx_book_theme" - -html_title = "Continuity" - -# 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"] diff --git a/docs/source/continuity.rst b/docs/source/continuity.rst deleted file mode 100644 index 62fae3d2..00000000 --- a/docs/source/continuity.rst +++ /dev/null @@ -1,10 +0,0 @@ -Continuity -========== - -Overview --------- - -.. automodule:: continuity - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst deleted file mode 100644 index 95758148..00000000 --- a/docs/source/getting_started/installation.rst +++ /dev/null @@ -1,8 +0,0 @@ -Installation -============ - -.. code-block:: - - git clone https://github.com/aai-institute/Continuity.git - cd Continuity - pip install -e . diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index d5d1a288..00000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -Continuity -========== - -.. image:: _static/logo.png - :width: 400 - :alt: Continuity - -Mapping continuous functions with neural networks. - -.. toctree:: - :maxdepth: 2 - :caption: Getting started - - getting_started/installation - -.. toctree:: - :maxdepth: 1 - :caption: Documentation - - modules diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index 1bf657d1..00000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -Modules -======= - -.. toctree:: - :maxdepth: 4 - - continuity diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..3d49ea1e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,14 @@ +site_name: Continuity +nav: + - Home: index.md + - Installation: installation.md + - Documentation: documentation.md + - About: about.md +theme: + name: readthedocs + locale: "en" + logo: img/logo.png + +plugins: + - search + - mkdocstrings