From f0cb14d0cf3053c05d811e7f31d5bbdcd4fb22e7 Mon Sep 17 00:00:00 2001
From: Max Paulus <m.paulus@uva.nl>
Date: Wed, 25 Sep 2024 13:58:13 +0200
Subject: [PATCH] added props to docs

---
 .github/workflows/docs.yml |  1 +
 .gitignore                 |  2 ++
 doc/api.md                 | 13 +++++++++----
 doc/conf.py                |  2 +-
 4 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index d053b713..d3568bea 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      - sphinx-docs-workflow
   pull_request:
     branches:
       - master
diff --git a/.gitignore b/.gitignore
index d7127ce7..774de54e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,6 +9,8 @@
 
 # testing
 /coverage
+/_build
+/.venv
 
 # production
 /build
diff --git a/doc/api.md b/doc/api.md
index 67d4212d..57b42115 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -1,22 +1,27 @@
 # API reference
 
-## Helpers
+## Props
 
-### Extraction helpers
+```{eval-rst}
+.. automodule:: port.api.props
+   :members:
+```
+
+## Extraction helpers
 
 ```{eval-rst}
 .. automodule:: port.helpers.extraction_helpers
    :members:
 ```
 
-### Port helpers
+## Port helpers
 
 ```{eval-rst}
 .. automodule:: port.helpers.port_helpers
    :members:
 ```
 
-### Validation
+## Validation
 
 ```{eval-rst}
 .. automodule:: port.helpers.validate
diff --git a/doc/conf.py b/doc/conf.py
index bdeeb861..48622360 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -32,5 +32,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'haiku'
 html_static_path = ['_static']