From 88aa1111b9eda9e64136b20d09f13593959edf70 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Thu, 14 Nov 2024 15:39:26 +0000 Subject: [PATCH 1/9] try instal test of project --- .github/workflows/deploy-documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index 16a38668..22258757 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -33,7 +33,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install sphinx sphinx-autobuild sphinx_rtd_theme + pip install -e [test] - name: Generate Documentation run: | From cdf9738823cd31fa41d2cf3ec597b749346282e4 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Thu, 14 Nov 2024 16:01:07 +0000 Subject: [PATCH 2/9] forgot a . --- .github/workflows/deploy-documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index 22258757..0ede0799 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -33,7 +33,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -e [test] + pip install -e .[test] - name: Generate Documentation run: | From ae503746687a440df2d0a3c7d5d261891c86b047 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Thu, 14 Nov 2024 16:06:00 +0000 Subject: [PATCH 3/9] attempt 2 --- .github/workflows/deploy-documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index 0ede0799..0a6dfb06 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -33,6 +33,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip + pip install --upgrade pip setuptools wheel pip install -e .[test] - name: Generate Documentation From baf534c0ad831531e06060192541bfe68d4bbf12 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Thu, 14 Nov 2024 16:11:19 +0000 Subject: [PATCH 4/9] dont error if version isnt found --- version.py | 1 - 1 file changed, 1 deletion(-) diff --git a/version.py b/version.py index 06368ae7..dde5cc14 100644 --- a/version.py +++ b/version.py @@ -11,7 +11,6 @@ def get_version(): ) except subprocess.CalledProcessError: print("Unable to get version number from git tags") - exit(1) def next_version(): From 9a0b86aca1ebae7e9b6c165291728ae167bb3b18 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Thu, 14 Nov 2024 16:24:40 +0000 Subject: [PATCH 5/9] try just using make init --- .github/workflows/deploy-documentation.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index 0a6dfb06..595493b3 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -32,9 +32,7 @@ jobs: - name: Install dependencies run: | - python -m pip install --upgrade pip - pip install --upgrade pip setuptools wheel - pip install -e .[test] + make init - name: Generate Documentation run: | From 4fd77d39359df56014a1c8465438c54fdbbf32b6 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Thu, 14 Nov 2024 16:28:20 +0000 Subject: [PATCH 6/9] update to match other CI pipeline --- .github/workflows/deploy-documentation.yml | 4 +++- version.py | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index 595493b3..bc6defe9 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -23,7 +23,9 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v3 + uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Set up Python uses: actions/setup-python@v4 diff --git a/version.py b/version.py index dde5cc14..06368ae7 100644 --- a/version.py +++ b/version.py @@ -11,6 +11,7 @@ def get_version(): ) except subprocess.CalledProcessError: print("Unable to get version number from git tags") + exit(1) def next_version(): From 3ebb1b712550ae126c2b29c9f185467896ed2d19 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Fri, 6 Dec 2024 15:27:17 +0000 Subject: [PATCH 7/9] remove autogenerated files --- docs/digital_land.adapter.rst | 21 -- docs/digital_land.datatype.rst | 141 ------------- .../digital_land.expectations.checkpoints.rst | 37 ---- docs/digital_land.expectations.rst | 61 ------ docs/digital_land.package.rst | 53 ----- docs/digital_land.phase.rst | 197 ------------------ docs/digital_land.plugins.rst | 37 ---- docs/digital_land.rst | 172 --------------- docs/digital_land.store.rst | 45 ---- docs/digital_land.utils.rst | 29 --- docs/modules.rst | 7 - 11 files changed, 800 deletions(-) delete mode 100644 docs/digital_land.adapter.rst delete mode 100644 docs/digital_land.datatype.rst delete mode 100644 docs/digital_land.expectations.checkpoints.rst delete mode 100644 docs/digital_land.expectations.rst delete mode 100644 docs/digital_land.package.rst delete mode 100644 docs/digital_land.phase.rst delete mode 100644 docs/digital_land.plugins.rst delete mode 100644 docs/digital_land.rst delete mode 100644 docs/digital_land.store.rst delete mode 100644 docs/digital_land.utils.rst delete mode 100644 docs/modules.rst diff --git a/docs/digital_land.adapter.rst b/docs/digital_land.adapter.rst deleted file mode 100644 index 70f53786..00000000 --- a/docs/digital_land.adapter.rst +++ /dev/null @@ -1,21 +0,0 @@ -digital\_land.adapter package -============================= - -Submodules ----------- - -digital\_land.adapter.file module ---------------------------------- - -.. automodule:: digital_land.adapter.file - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.adapter - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.datatype.rst b/docs/digital_land.datatype.rst deleted file mode 100644 index fc983f4d..00000000 --- a/docs/digital_land.datatype.rst +++ /dev/null @@ -1,141 +0,0 @@ -digital\_land.datatype package -============================== - -Submodules ----------- - -digital\_land.datatype.address module -------------------------------------- - -.. automodule:: digital_land.datatype.address - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.datatype module --------------------------------------- - -.. automodule:: digital_land.datatype.datatype - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.date module ----------------------------------- - -.. automodule:: digital_land.datatype.date - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.decimal module -------------------------------------- - -.. automodule:: digital_land.datatype.decimal - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.enum module ----------------------------------- - -.. automodule:: digital_land.datatype.enum - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.factory module -------------------------------------- - -.. automodule:: digital_land.datatype.factory - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.flag module ----------------------------------- - -.. automodule:: digital_land.datatype.flag - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.integer module -------------------------------------- - -.. automodule:: digital_land.datatype.integer - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.latitude module --------------------------------------- - -.. automodule:: digital_land.datatype.latitude - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.longitude module ---------------------------------------- - -.. automodule:: digital_land.datatype.longitude - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.multipolygon module ------------------------------------------- - -.. automodule:: digital_land.datatype.multipolygon - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.organisation module ------------------------------------------- - -.. automodule:: digital_land.datatype.organisation - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.point module ------------------------------------ - -.. automodule:: digital_land.datatype.point - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.string module ------------------------------------- - -.. automodule:: digital_land.datatype.string - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.uri module ---------------------------------- - -.. automodule:: digital_land.datatype.uri - :members: - :undoc-members: - :show-inheritance: - -digital\_land.datatype.wkt module ---------------------------------- - -.. automodule:: digital_land.datatype.wkt - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.datatype - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.expectations.checkpoints.rst b/docs/digital_land.expectations.checkpoints.rst deleted file mode 100644 index 39556055..00000000 --- a/docs/digital_land.expectations.checkpoints.rst +++ /dev/null @@ -1,37 +0,0 @@ -digital\_land.expectations.checkpoints package -============================================== - -Submodules ----------- - -digital\_land.expectations.checkpoints.base module --------------------------------------------------- - -.. automodule:: digital_land.expectations.checkpoints.base - :members: - :undoc-members: - :show-inheritance: - -digital\_land.expectations.checkpoints.converted\_resource module ------------------------------------------------------------------ - -.. automodule:: digital_land.expectations.checkpoints.converted_resource - :members: - :undoc-members: - :show-inheritance: - -digital\_land.expectations.checkpoints.dataset module ------------------------------------------------------ - -.. automodule:: digital_land.expectations.checkpoints.dataset - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.expectations.checkpoints - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.expectations.rst b/docs/digital_land.expectations.rst deleted file mode 100644 index 62724e15..00000000 --- a/docs/digital_land.expectations.rst +++ /dev/null @@ -1,61 +0,0 @@ -digital\_land.expectations package -================================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - digital_land.expectations.checkpoints - -Submodules ----------- - -digital\_land.expectations.commands module ------------------------------------------- - -.. automodule:: digital_land.expectations.commands - :members: - :undoc-members: - :show-inheritance: - -digital\_land.expectations.exception module -------------------------------------------- - -.. automodule:: digital_land.expectations.exception - :members: - :undoc-members: - :show-inheritance: - -digital\_land.expectations.issue module ---------------------------------------- - -.. automodule:: digital_land.expectations.issue - :members: - :undoc-members: - :show-inheritance: - -digital\_land.expectations.result module ----------------------------------------- - -.. automodule:: digital_land.expectations.result - :members: - :undoc-members: - :show-inheritance: - -digital\_land.expectations.utils module ---------------------------------------- - -.. automodule:: digital_land.expectations.utils - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.expectations - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.package.rst b/docs/digital_land.package.rst deleted file mode 100644 index b321231d..00000000 --- a/docs/digital_land.package.rst +++ /dev/null @@ -1,53 +0,0 @@ -digital\_land.package package -============================= - -Submodules ----------- - -digital\_land.package.csv module --------------------------------- - -.. automodule:: digital_land.package.csv - :members: - :undoc-members: - :show-inheritance: - -digital\_land.package.dataset module ------------------------------------- - -.. automodule:: digital_land.package.dataset - :members: - :undoc-members: - :show-inheritance: - -digital\_land.package.organisation module ------------------------------------------ - -.. automodule:: digital_land.package.organisation - :members: - :undoc-members: - :show-inheritance: - -digital\_land.package.package module ------------------------------------- - -.. automodule:: digital_land.package.package - :members: - :undoc-members: - :show-inheritance: - -digital\_land.package.sqlite module ------------------------------------ - -.. automodule:: digital_land.package.sqlite - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.package - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.phase.rst b/docs/digital_land.phase.rst deleted file mode 100644 index 33e1846f..00000000 --- a/docs/digital_land.phase.rst +++ /dev/null @@ -1,197 +0,0 @@ -digital\_land.phase package -=========================== - -Submodules ----------- - -digital\_land.phase.combine module ----------------------------------- - -.. automodule:: digital_land.phase.combine - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.concat module ---------------------------------- - -.. automodule:: digital_land.phase.concat - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.convert module ----------------------------------- - -.. automodule:: digital_land.phase.convert - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.default module ----------------------------------- - -.. automodule:: digital_land.phase.default - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.dump module -------------------------------- - -.. automodule:: digital_land.phase.dump - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.factor module ---------------------------------- - -.. automodule:: digital_land.phase.factor - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.filter module ---------------------------------- - -.. automodule:: digital_land.phase.filter - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.harmonise module ------------------------------------- - -.. automodule:: digital_land.phase.harmonise - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.load module -------------------------------- - -.. automodule:: digital_land.phase.load - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.lookup module ---------------------------------- - -.. automodule:: digital_land.phase.lookup - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.map module ------------------------------- - -.. automodule:: digital_land.phase.map - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.migrate module ----------------------------------- - -.. automodule:: digital_land.phase.migrate - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.normalise module ------------------------------------- - -.. automodule:: digital_land.phase.normalise - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.organisation module ---------------------------------------- - -.. automodule:: digital_land.phase.organisation - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.parse module --------------------------------- - -.. automodule:: digital_land.phase.parse - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.patch module --------------------------------- - -.. automodule:: digital_land.phase.patch - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.phase module --------------------------------- - -.. automodule:: digital_land.phase.phase - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.pivot module --------------------------------- - -.. automodule:: digital_land.phase.pivot - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.prefix module ---------------------------------- - -.. automodule:: digital_land.phase.prefix - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.priority module ------------------------------------ - -.. automodule:: digital_land.phase.priority - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.prune module --------------------------------- - -.. automodule:: digital_land.phase.prune - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.reference module ------------------------------------- - -.. automodule:: digital_land.phase.reference - :members: - :undoc-members: - :show-inheritance: - -digital\_land.phase.save module -------------------------------- - -.. automodule:: digital_land.phase.save - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.phase - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.plugins.rst b/docs/digital_land.plugins.rst deleted file mode 100644 index c656f11d..00000000 --- a/docs/digital_land.plugins.rst +++ /dev/null @@ -1,37 +0,0 @@ -digital\_land.plugins package -============================= - -Submodules ----------- - -digital\_land.plugins.arcgis module ------------------------------------ - -.. automodule:: digital_land.plugins.arcgis - :members: - :undoc-members: - :show-inheritance: - -digital\_land.plugins.sparql module ------------------------------------ - -.. automodule:: digital_land.plugins.sparql - :members: - :undoc-members: - :show-inheritance: - -digital\_land.plugins.wfs module --------------------------------- - -.. automodule:: digital_land.plugins.wfs - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.plugins - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.rst b/docs/digital_land.rst deleted file mode 100644 index 2bbab1ba..00000000 --- a/docs/digital_land.rst +++ /dev/null @@ -1,172 +0,0 @@ -digital\_land package -===================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - digital_land.adapter - digital_land.datatype - digital_land.expectations - digital_land.package - digital_land.phase - digital_land.plugins - digital_land.store - digital_land.utils - -Submodules ----------- - -digital\_land.api module ------------------------- - -.. automodule:: digital_land.api - :members: - :undoc-members: - :show-inheritance: - -digital\_land.check module --------------------------- - -.. automodule:: digital_land.check - :members: - :undoc-members: - :show-inheritance: - -digital\_land.cli module ------------------------- - -.. automodule:: digital_land.cli - :members: - :undoc-members: - :show-inheritance: - -digital\_land.collect module ----------------------------- - -.. automodule:: digital_land.collect - :members: - :undoc-members: - :show-inheritance: - -digital\_land.collection module -------------------------------- - -.. automodule:: digital_land.collection - :members: - :undoc-members: - :show-inheritance: - -digital\_land.column\_fields module ------------------------------------ - -.. automodule:: digital_land.column_fields - :members: - :undoc-members: - :show-inheritance: - -digital\_land.command\_arguments module ---------------------------------------- - -.. automodule:: digital_land.command_arguments - :members: - :undoc-members: - :show-inheritance: - -digital\_land.commands module ------------------------------ - -.. automodule:: digital_land.commands - :members: - :undoc-members: - :show-inheritance: - -digital\_land.dataset module ----------------------------- - -.. automodule:: digital_land.dataset - :members: - :undoc-members: - :show-inheritance: - -digital\_land.fetch module --------------------------- - -.. automodule:: digital_land.fetch - :members: - :undoc-members: - :show-inheritance: - -digital\_land.log module ------------------------- - -.. automodule:: digital_land.log - :members: - :undoc-members: - :show-inheritance: - -digital\_land.makerules module ------------------------------- - -.. automodule:: digital_land.makerules - :members: - :undoc-members: - :show-inheritance: - -digital\_land.organisation module ---------------------------------- - -.. automodule:: digital_land.organisation - :members: - :undoc-members: - :show-inheritance: - -digital\_land.pipeline module ------------------------------ - -.. automodule:: digital_land.pipeline - :members: - :undoc-members: - :show-inheritance: - -digital\_land.register module ------------------------------ - -.. automodule:: digital_land.register - :members: - :undoc-members: - :show-inheritance: - -digital\_land.schema module ---------------------------- - -.. automodule:: digital_land.schema - :members: - :undoc-members: - :show-inheritance: - -digital\_land.specification module ----------------------------------- - -.. automodule:: digital_land.specification - :members: - :undoc-members: - :show-inheritance: - -digital\_land.update module ---------------------------- - -.. automodule:: digital_land.update - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.store.rst b/docs/digital_land.store.rst deleted file mode 100644 index e33744b8..00000000 --- a/docs/digital_land.store.rst +++ /dev/null @@ -1,45 +0,0 @@ -digital\_land.store package -=========================== - -Submodules ----------- - -digital\_land.store.csv module ------------------------------- - -.. automodule:: digital_land.store.csv - :members: - :undoc-members: - :show-inheritance: - -digital\_land.store.item module -------------------------------- - -.. automodule:: digital_land.store.item - :members: - :undoc-members: - :show-inheritance: - -digital\_land.store.memory module ---------------------------------- - -.. automodule:: digital_land.store.memory - :members: - :undoc-members: - :show-inheritance: - -digital\_land.store.store module --------------------------------- - -.. automodule:: digital_land.store.store - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.store - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/digital_land.utils.rst b/docs/digital_land.utils.rst deleted file mode 100644 index ee634fd4..00000000 --- a/docs/digital_land.utils.rst +++ /dev/null @@ -1,29 +0,0 @@ -digital\_land.utils package -=========================== - -Submodules ----------- - -digital\_land.utils.add\_endpoints\_utils module ------------------------------------------------- - -.. automodule:: digital_land.utils.add_endpoints_utils - :members: - :undoc-members: - :show-inheritance: - -digital\_land.utils.gdal\_utils module --------------------------------------- - -.. automodule:: digital_land.utils.gdal_utils - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: digital_land.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/modules.rst b/docs/modules.rst deleted file mode 100644 index e7508534..00000000 --- a/docs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -digital_land -============ - -.. toctree:: - :maxdepth: 4 - - digital_land From 1673491bfcd1d15fedb092b998bee9a448fe4260 Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Fri, 6 Dec 2024 16:14:26 +0000 Subject: [PATCH 8/9] fix building guidance --- .github/workflows/deploy-documentation.yml | 2 +- .gitignore | 2 ++ Makefile | 12 +++++------- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index bc6defe9..0c951221 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -38,7 +38,7 @@ jobs: - name: Generate Documentation run: | - sphinx-build -b html docs/ docs/_build + make docs - name: Upload artifact uses: actions/upload-pages-artifact@v1 diff --git a/.gitignore b/.gitignore index 054ca434..7b58a401 100644 --- a/.gitignore +++ b/.gitignore @@ -28,3 +28,5 @@ pyrightconfig.json # don't store html build file for docs /docs/_build +docs/digital_land* +docs/modules.rst diff --git a/Makefile b/Makefile index 22b2d63a..c6e9a72f 100644 --- a/Makefile +++ b/Makefile @@ -40,17 +40,15 @@ endif # install pre-commits pre-commit install -# build docs from doc strings -.PHONY: api-docs -api-docs: - sphinx-apidoc -o docs/ api/digital_land -# Build documentation with Sphinx +# Build documentation with Sphinx use for deploying documentation .PHONY: docs docs: api-docs + sphinx-apidoc -o docs/ digital_land sphinx-build -b html docs/ docs/_build -# Serve the documentation locally with live-reloading -serve-docs: api-docs +# Serve the documentation locally with live-reloading. Use this for local building +serve-docs: + sphinx-apidoc -o docs/ digital_land sphinx-autobuild docs/ docs/_build --host 0.0.0.0 --port 8000 # Clean up the generated documentation From 0a872fc1c58bf976e4913b801b86e1f2277391de Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Fri, 6 Dec 2024 16:23:14 +0000 Subject: [PATCH 9/9] correct target --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index c6e9a72f..655d5d22 100644 --- a/Makefile +++ b/Makefile @@ -42,7 +42,7 @@ endif # Build documentation with Sphinx use for deploying documentation .PHONY: docs -docs: api-docs +docs: sphinx-apidoc -o docs/ digital_land sphinx-build -b html docs/ docs/_build