Create API reference

ImperialCollegeLondon · Mar 22, 2024 · b273bca · b273bca
1 parent 91dd748
commit b273bca
Show file tree

Hide file tree

Showing 13 changed files with 64 additions and 0 deletions.
diff --git a/AUTHORS.md → docs/AUTHORS.md b/AUTHORS.md → docs/AUTHORS.md
diff --git a/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
diff --git a/swmmanywhere/HISTORY.md → docs/HISTORY.md b/swmmanywhere/HISTORY.md → docs/HISTORY.md
diff --git a/docs/reference-geospatial-utilities.md b/docs/reference-geospatial-utilities.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/geospatial_utilities.py
+
+::: swmmanywhere.geospatial_utilities
diff --git a/docs/reference-graph-utilities.md b/docs/reference-graph-utilities.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/graph_utilities.py
+
+::: swmmanywhere.graph_utilities
diff --git a/docs/reference-logging.md b/docs/reference-logging.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/logging.py
+
+::: swmmanywhere.logging
diff --git a/docs/reference-metric-utilities.md b/docs/reference-metric-utilities.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/metric_utilties.py
+
+::: swmmanywhere.metric_utilities
diff --git a/docs/reference-parameters.md b/docs/reference-parameters.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/parameters.py
+
+::: swmmanywhere.parameters
diff --git a/docs/reference-post-processing.md b/docs/reference-post-processing.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/post_processing.py
+
+::: swmmanywhere.post_processing
diff --git a/docs/reference-preprocessing.md b/docs/reference-preprocessing.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/preprocessing.py
+
+::: swmmanywhere.preprocessing
diff --git a/docs/reference.md b/docs/reference.md
@@ -0,0 +1,3 @@
+# Reference for SWMManywhere/swmmanywhere.py
+
+::: swmmanywhere.swmmanywhere
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,40 @@
+site_name: SWMManywhere docs
+
+theme:
+  name: "material"
+
+extra_css:
+  - stylesheets/extra.css
+
+
+plugins:
+  - mkdocstrings
+  - mkdocs-jupyter:
+      execute: true
+  - search
+  # - bibtex:
+      # bib_file: "./docs/paper/paper.bib"
+      # csl_file: "./docs/paper/apa.csl"
+      # cite_inline: false
+  - coverage:
+      page_name: coverage  # default
+      html_report_dir: htmlcov  # default
+  # - gen-files:
+    #  scripts:
+        # - docs/create_class_page.py
+
+markdown_extensions:
+  - footnotes
+
+nav:
+  - Contributing: CONTRIBUTING.md
+  - API reference:
+    - SWMManywhere: reference.md
+    - Graph utilities: reference-graph-utilities.md
+    - Geospatial utilities: reference-geospatial-utilities.md
+    - Metric utilities: reference-metric-utilities.md
+    - Logging: reference-logging.md
+    - Parameters: reference-parameters.md
+    - Post processing: reference-post-processing.md
+    - Preprocessing: reference-preprocessing.md
+  - Coverage report: coverage.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/geospatial_utilities.py

		::: swmmanywhere.geospatial_utilities
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/graph_utilities.py

		::: swmmanywhere.graph_utilities
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/logging.py

		::: swmmanywhere.logging
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/metric_utilties.py

		::: swmmanywhere.metric_utilities
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/parameters.py

		::: swmmanywhere.parameters
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/post_processing.py

		::: swmmanywhere.post_processing
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/preprocessing.py

		::: swmmanywhere.preprocessing
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference for SWMManywhere/swmmanywhere.py

		::: swmmanywhere.swmmanywhere