Merge pull request #59 from ecmwf/bugfix/docs

Bugfix/docs
ecmwf · Oct 14, 2024 · 16bdad5 · 16bdad5
2 parents c34200d + 752bccf
commit 16bdad5
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,6 +19,29 @@ jobs:
       - run: black --check .
       - run: flake8 .
 
+  docs:
+    name: docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: test
+          environment-file: docs/environment.yml
+          python-version: 3.8
+          auto-activate-base: false
+      - name: Conda check
+        shell: bash -l {0}
+        run: |
+          conda info
+          conda list
+      - name: Install pyflow and docs
+        shell: bash -l {0}  # required to load conda I think
+        run: |
+          python -m pip install .
+          cd docs
+          make html
+
   setup:
     name: setup
     runs-on: ubuntu-latest

diff --git a/docs/content/api-reference.rst b/docs/content/api-reference.rst
@@ -49,6 +49,14 @@ Variable
 .. autoclass:: pyflow.Edit
 
 
+GeneratedVariable
+~~~~~~~~~~~~~~~~~
+
+.. _GeneratedVariable:
+
+.. autoclass:: pyflow.GeneratedVariable
+
+
 .. _Trigger:
 
 Trigger

diff --git a/docs/environment.yml b/docs/environment.yml
@@ -11,6 +11,7 @@ dependencies:
   - requests
   - pytest
   - pygraphviz
+  - pandoc
   - pip:
     - ipykernel
     - nbsphinx

diff --git a/pyflow/__init__.py b/pyflow/__init__.py
@@ -11,6 +11,7 @@
     Defstatus,
     Edit,
     Event,
+    GeneratedVariable,
     InLimit,
     Inlimit,
     Label,