Fix and enable some doc tests

AequilibraE · May 15, 2024 · a5f64f7 · a5f64f7
1 parent 1c97bc9
commit a5f64f7
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -43,7 +43,7 @@ jobs:
 
     - name: Test docstrings
       run: |
-        # python -m pytest --doctest-modules ./aequilibrae --ignore=aequilibrae/distribution/setup_ipf.py --ignore=aequilibrae/paths/setup_assignment.py --doctest-continue-on-failure
+        python -m pytest --doctest-modules aequilibrae/log.py aequilibrae/parameters.py aequilibrae/paths/vdf.py
 
     - name: Build documentation
       run: |

diff --git a/aequilibrae/log.py b/aequilibrae/log.py
@@ -12,7 +12,8 @@ class Log:
 
         >>> from aequilibrae import Project
 
-        >>> project = Project.from_path("/tmp/test_project")
+        >>> project = Project()
+        >>> project.new(tmp_path_empty)
 
         >>> log = project.log()
 

diff --git a/aequilibrae/parameters.py b/aequilibrae/parameters.py
@@ -21,7 +21,8 @@ class Parameters:
 
         >>> from aequilibrae import Project, Parameters
 
-        >>> project = Project.from_path("/tmp/test_project")
+        >>> project = Project()
+        >>> project.new(tmp_path_empty)
 
         >>> p = Parameters(project)
 

diff --git a/tests/aequilibrae/conftest.py → conftest.py b/tests/aequilibrae/conftest.py → conftest.py
@@ -14,7 +14,7 @@
 from aequilibrae.utils.create_example import create_example
 from aequilibrae.utils.spatialite_utils import ensure_spatialite_binaries
 
-from ..data import siouxfalls_project
+from tests.data import siouxfalls_project
 
 DEFAULT_PROJECT = siouxfalls_project
 ensure_spatialite_binaries()
@@ -98,3 +98,10 @@ def create_gtfs_project(create_path):
 @pytest.fixture
 def transit_conn(create_gtfs_project):
     return database_connection("transit")
+
+
+@pytest.fixture(autouse=True)
+def doctest_fixtures(doctest_namespace, tmp_path, create_path):
+    doctest_namespace['tmp_path'] = tmp_path
+    doctest_namespace['tmp_path_empty'] = str(create_path)
+    print(doctest_namespace)