Refactor to Properdocs

.github/workflows/publish-gh-pages.yml

@@ -46,8 +46,8 @@ jobs:
           make install-dev
           make install-docs
 
-      - name: Run mkdocs deploy
+      - name: Run properdocs deploy
         run: |
-          uv run mkdocs gh-deploy
+          uv run properdocs gh-deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.make/docs.make

@@ -1,12 +1,12 @@
 ## -- Docs targets -------------------------------------------------------------------------------------------------- ##
 .PHONY: preview-docs
 preview-docs: install-docs ## Preview the documentation site locally
-	@$(ENV_COMMAND_TOOL) mkdocs serve -a 0.0.0.0:7000
+	@$(ENV_COMMAND_TOOL) properdocs serve -a 127.0.0.1:7000
 
 
 .PHONY: build-docs
 build-docs: install-docs ## Build the documentation files locally
-	@$(ENV_COMMAND_TOOL) mkdocs build
+	@$(ENV_COMMAND_TOOL) properdocs build
 
 .PHONY: deploy-docs
 deploy-docs: install-docs ## Publish and deploy the documentation to the live Github page
@@ -18,7 +18,7 @@ deploy-docs: install-docs ## Publish and deploy the documentation to the live Gi
 	case $$ans in \
 		[Yy]*) \
 			echo""; \
-			$(ENV_COMMAND_TOOL) mkdocs gh-deploy; \
+			$(ENV_COMMAND_TOOL) properdocs gh-deploy; \
 			echo""; \
 			;; \
 		*) \

.make/uv.make

@@ -264,7 +264,7 @@ install-jupyterlab: uv-install-auto ## Install Jupyter Lab dependencies
 	@make -s _remind-env-activate
 
 .PHONY: install-docs
-install-docs: uv-install-auto ## Install docs related dependencies (mkdocs)
+install-docs: uv-install-auto ## Install docs related dependencies (properdocs)
 	@$(ENV_INSTALL_TOOL) --extra docs --all-packages
 	@make -s _remind-env-activate
 

docs/mkdocs/scripts/gen_ref_pages.py → docs/properdocs/scripts/gen_ref_pages.py

@@ -7,7 +7,7 @@
 nav = mkdocs_gen_files.Nav()
 
 root = Path(__file__).parent.parent.parent.parent
-src = root / "geospatial_tools"
+src = root / "src"
 
 for path in sorted(src.rglob("*.py")):
     module_path = path.relative_to(src).with_suffix("")

docs/mkdocs/sections/user-guide/notebook-examples.md → docs/properdocs/sections/user-guide/notebook-examples.md

@@ -4,3 +4,4 @@ There are a few notebook examples available.
 
 - [How to use STAC API](https://github.com/RolnickLab/geospatial-tools/blob/main/notebooks/stac_api_tools.ipynb)
 - [Exploring Sentinel 2 data from Planetary Computer](https://github.com/RolnickLab/geospatial-tools/blob/main/notebooks/planetary_computer_sentinel2_exploration.ipynb)
+- [Exploring Sentinel 2 data from Copernicus](https://github.com/RolnickLab/geospatial-tools/blob/main/notebooks/copernicus_sentinel2_exploration.ipynb)

mkdocs.yml → properdocs.yml

@@ -2,7 +2,7 @@ site_name: Geospatial Tools
 site_description: A package contain classes and utilities to help with geospatial data
 repo_url: https://github.com/RolnickLab/geospatial-tools
 
-docs_dir: docs/mkdocs
+docs_dir: docs/properdocs
 nav:
   - User Guide:
       - sections/user-guide/user-guide.md
@@ -19,13 +19,15 @@ theme:
 
   palette:
     - media: "(prefers-color-scheme)"
+      primary: deep orange
       toggle:
         icon: material/brightness-auto
         name: Switch to light mode
 
         # Palette toggle for light mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
+      primary: deep orange
 
       toggle:
         icon: material/brightness-7
@@ -34,6 +36,7 @@ theme:
     # Palette toggle for dark mode
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
+      primary: deep orange
       toggle:
         icon: material/brightness-4
         name: Switch to system preference
@@ -52,14 +55,14 @@ plugins:
   - search
   - gen-files:
         scripts:
-          - docs/mkdocs/scripts/gen_ref_pages.py
+          - docs/properdocs/scripts/gen_ref_pages.py
   - literate-nav
   - section-index
   - mkdocstrings:
       default_handler: python
       handlers:
         python:
-          paths: [geospatial_tools]
+          paths: [src]
           options:
             inherited_members: true
             docstring_style: google
@@ -77,4 +80,3 @@ plugins:
             show_symbol_type_toc: true
             line_length: 88
             merge_init_into_class: true
-

pyproject.toml

@@ -59,12 +59,12 @@ dev = [
 ]
 [project.optional-dependencies]
 docs =[
-    "mkdocs>=1.6.1",
     "mkdocs-material>=9.6.20",
     "mkdocs-gen-files>=0.5.0",
     "mkdocs-literate-nav>=0.6.2",
     "mkdocs-section-index>=0.3.10",
     "mkdocstrings-python>=1.18.2",
+    "properdocs>=1.6.7",
 ]
 lab = [
     "jupyterlab>=4.0.10",