Merge pull request #11 from UUDigitalHumanitieslab/feature/documentation

documentation site
UUDigitalHumanitieslab · Mar 13, 2024 · ee0d349 · ee0d349
2 parents 008749c + bae6c28
commit ee0d349
Show file tree

Hide file tree

Showing 25 changed files with 1,483 additions and 241 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,4 +29,5 @@ venv.bak/
 
 *.egg-info/
 
-dist/
+dist/
+build/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,4 +14,28 @@ Run unit tests with
 
 ```sh
 pytest
-```
+```
+
+## Writing documentation
+
+Documentation is based on [mkdocs](https://www.mkdocs.org).
+
+### Commands
+
+Start the live-reloading docs server:
+
+```sh
+mkdocs serve
+```
+
+Build the documentation site:
+
+```sh
+mkdocs build
+```
+
+Print help message and exit:
+
+```sh
+mkdocs -h
+```
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,37 @@
+# API documentation
+
+## Core classes
+
+__Module:__ `ianalyzer_readers.readers.core`
+
+::: ianalyzer_readers.readers.core
+
+## CSV reader
+
+__Module:__ `ianalyzer_readers.readers.csv`
+
+::: ianalyzer_readers.readers.csv
+
+## XLSX reader
+
+__Module:__ `ianalyzer_readers.readers.xlsx`
+
+::: ianalyzer_readers.readers.xlsx
+
+## XML reader
+
+__Module:__ `ianalyzer_readers.readers.xml`
+
+::: ianalyzer_readers.readers.xml
+
+## HTML reader
+
+__Module:__ `ianalyzer_readers.readers.html`
+
+::: ianalyzer_readers.readers.html
+
+## Extractors
+
+__Module:__ `ianalyzer_readers.extract`
+
+::: ianalyzer_readers.extract