added props to docs

d3i-infra · Sep 25, 2024 · f0cb14d · f0cb14d
1 parent ff7dbd1
commit f0cb14d
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git 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
@@ -9,6 +9,8 @@
 
 # testing
 /coverage
+/_build
+/.venv
 
 # production
 /build

diff --git 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
@@ -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']
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,8 @@ @@
     # testing
     /coverage
+    /_build
+    /.venv
     # production
     /build
@@ Expand Down @@