From b273bca4167321150ddec52c55cab96fc302ca1d Mon Sep 17 00:00:00 2001 From: Dobson Date: Fri, 22 Mar 2024 12:05:38 +0000 Subject: [PATCH] Create API reference --- AUTHORS.md => docs/AUTHORS.md | 0 CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 {swmmanywhere => docs}/HISTORY.md | 0 docs/reference-geospatial-utilities.md | 3 ++ docs/reference-graph-utilities.md | 3 ++ docs/reference-logging.md | 3 ++ docs/reference-metric-utilities.md | 3 ++ docs/reference-parameters.md | 3 ++ docs/reference-post-processing.md | 3 ++ docs/reference-preprocessing.md | 3 ++ docs/reference.md | 3 ++ mkdocs.yml | 40 +++++++++++++++++++ 13 files changed, 64 insertions(+) rename AUTHORS.md => docs/AUTHORS.md (100%) rename CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md (100%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) rename {swmmanywhere => docs}/HISTORY.md (100%) create mode 100644 docs/reference-geospatial-utilities.md create mode 100644 docs/reference-graph-utilities.md create mode 100644 docs/reference-logging.md create mode 100644 docs/reference-metric-utilities.md create mode 100644 docs/reference-parameters.md create mode 100644 docs/reference-post-processing.md create mode 100644 docs/reference-preprocessing.md create mode 100644 docs/reference.md create mode 100644 mkdocs.yml diff --git a/AUTHORS.md b/docs/AUTHORS.md similarity index 100% rename from AUTHORS.md rename to docs/AUTHORS.md diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/swmmanywhere/HISTORY.md b/docs/HISTORY.md similarity index 100% rename from swmmanywhere/HISTORY.md rename to docs/HISTORY.md diff --git a/docs/reference-geospatial-utilities.md b/docs/reference-geospatial-utilities.md new file mode 100644 index 00000000..d756135e --- /dev/null +++ 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 new file mode 100644 index 00000000..2e9b697d --- /dev/null +++ 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 new file mode 100644 index 00000000..03807aa1 --- /dev/null +++ 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 new file mode 100644 index 00000000..4c6c0b35 --- /dev/null +++ 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 new file mode 100644 index 00000000..e21e0e1c --- /dev/null +++ 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 new file mode 100644 index 00000000..a07ec01e --- /dev/null +++ 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 new file mode 100644 index 00000000..bf3a8186 --- /dev/null +++ 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 new file mode 100644 index 00000000..04c7a5bd --- /dev/null +++ b/docs/reference.md @@ -0,0 +1,3 @@ +# Reference for SWMManywhere/swmmanywhere.py + +::: swmmanywhere.swmmanywhere diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..7c714fa4 --- /dev/null +++ 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 \ No newline at end of file