Replace sphinx by mkdocs.

aai-institute · Nov 20, 2023 · e6e20e6 · e6e20e6
1 parent 4259e53
commit e6e20e6
Show file tree

Hide file tree

Showing 18 changed files with 43 additions and 159 deletions.
diff --git 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
@@ -1,9 +1,8 @@
 <div align="center">
 
-# Continuity
+<img alt="Continuity" src="https://raw.githubusercontent.com/aai-institute/Continuity/main/docs/img/logo.png">
 
-<img alt="Continuity" src="
-https://raw.githubusercontent.com/aai-institute/Continuity/main/docs/docs/source/_static/logo.png">
+Mapping continuous functions with neural networks.
 
 </div>
 

diff --git a/docs/Makefile b/docs/Makefile
diff --git 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
@@ -0,0 +1,2 @@
+About
+==========
diff --git a/docs/documentation.md 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
diff --git a/docs/img/logo.png b/docs/img/logo.png
diff --git a/docs/index.md 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
@@ -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
@@ -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
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/continuity.rst b/docs/source/continuity.rst
diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
diff --git a/mkdocs.yml 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