diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index affca4c..0000000 --- a/docs/api.md +++ /dev/null @@ -1,10 +0,0 @@ -# API - -- [`asd.py`](api/asd.md) -- [`gwy.py`](api/gwy.md) -- [`ibw.py`](api/ibw.md) -- [`io`](api/io.md) -- [`jpk.py`](api/jpk.md) -- [`logging`](api/logging.md) -- [`spm.py`](api/spm.md) -- [`topostats.py`](api/topostats.md) diff --git a/docs/api/asd.md b/docs/api/asd.md index bce6e6c..f2db601 100644 --- a/docs/api/asd.md +++ b/docs/api/asd.md @@ -1,8 +1,3 @@ # ASD Modules ::: AFMReader.asd - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/api/gwy.md b/docs/api/gwy.md index 3e66aae..1b4378b 100644 --- a/docs/api/gwy.md +++ b/docs/api/gwy.md @@ -1,8 +1,3 @@ # GWY Modules ::: AFMReader.gwy - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/api/ibw.md b/docs/api/ibw.md index 3eb091f..116ce75 100644 --- a/docs/api/ibw.md +++ b/docs/api/ibw.md @@ -1,8 +1,3 @@ # IBW Modules ::: AFMReader.ibw - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..26c06d1 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,12 @@ +# API + +Details of the API can be found on the following pages. + +- [`asd.py`](asd.md) +- [`gwy.py`](gwy.md) +- [`ibw.py`](ibw.md) +- [`io`](io.md) +- [`jpk.py`](jpk.md) +- [`logging`](logging.md) +- [`spm.py`](spm.md) +- [`topostats.py`](topostats.md) diff --git a/docs/api/io.md b/docs/api/io.md index c42a6ce..12a24dd 100644 --- a/docs/api/io.md +++ b/docs/api/io.md @@ -1,8 +1,3 @@ # IO Modules ::: AFMReader.io - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/api/jpk.md b/docs/api/jpk.md index 988310d..4025f96 100644 --- a/docs/api/jpk.md +++ b/docs/api/jpk.md @@ -1,8 +1,3 @@ # JPK Modules ::: AFMReader.jpk - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/api/logging.md b/docs/api/logging.md index c5529dd..454e91b 100644 --- a/docs/api/logging.md +++ b/docs/api/logging.md @@ -1,8 +1,3 @@ # Logging Modules ::: AFMReader.logging - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/api/spm.md b/docs/api/spm.md index 1ec1c5b..a12d531 100644 --- a/docs/api/spm.md +++ b/docs/api/spm.md @@ -1,8 +1,3 @@ # SPM Modules ::: AFMReader.spm - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/api/topostats.md b/docs/api/topostats.md index 9336f60..307354d 100644 --- a/docs/api/topostats.md +++ b/docs/api/topostats.md @@ -1,8 +1,3 @@ # TopoStats Modules ::: AFMReader.topostats - handler: python - options: - docstring_style: numpy - rendering: - show_signature_annotations: true diff --git a/docs/index.md b/docs/index.md index 96a199d..6360c0b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ Lab](https://pyne-lab.uk/bio/) based at the [University of Sheffield](https://sh - [Contributing](contributing.md) - [Workflow](workflow.md) - [Links](links.md) -- [API](api.md) +- [API](api/index.md) ## Citing diff --git a/mkdocs.yml b/mkdocs.yml index 3bfe743..cd703f5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,7 +28,12 @@ extra: plugins: - mermaid2: - search - - mkdocstrings + - mkdocstrings: + handlers: + python: + options: + docstring_style: numpy + show_signature_annotations: true - mike: version: true @@ -44,3 +49,7 @@ markdown_extensions: - name: mermaid class: mermaid format: !!python/name:mermaid2.fence_mermaid + +watch: + - docs/ + - AFMReader/