Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions docs/api.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/api/asd.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# ASD Modules

::: AFMReader.asd
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
5 changes: 0 additions & 5 deletions docs/api/gwy.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# GWY Modules

::: AFMReader.gwy
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
5 changes: 0 additions & 5 deletions docs/api/ibw.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# IBW Modules

::: AFMReader.ibw
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
12 changes: 12 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 0 additions & 5 deletions docs/api/io.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# IO Modules

::: AFMReader.io
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
5 changes: 0 additions & 5 deletions docs/api/jpk.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# JPK Modules

::: AFMReader.jpk
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
5 changes: 0 additions & 5 deletions docs/api/logging.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# Logging Modules

::: AFMReader.logging
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
5 changes: 0 additions & 5 deletions docs/api/spm.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# SPM Modules

::: AFMReader.spm
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
5 changes: 0 additions & 5 deletions docs/api/topostats.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# TopoStats Modules

::: AFMReader.topostats
handler: python
options:
docstring_style: numpy
rendering:
show_signature_annotations: true
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 10 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,12 @@ extra:
plugins:
- mermaid2:
- search
- mkdocstrings
- mkdocstrings:
handlers:
python:
options:
docstring_style: numpy
show_signature_annotations: true
- mike:
version: true

Expand All @@ -44,3 +49,7 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid

watch:
- docs/
- AFMReader/