From 52913431edcb0d60f3e2e60b01669e3d8793169e Mon Sep 17 00:00:00 2001 From: sneakers-the-rat Date: Fri, 21 Jun 2024 17:43:40 -0700 Subject: [PATCH] unnest docs, make titles match module names in api docs --- README.md | 2 +- docs/api/data.md | 2 +- docs/api/devices.md | 2 +- docs/api/formats/index.md | 2 +- docs/api/formats/sdcard.md | 2 +- docs/api/formats/stream.md | 2 +- docs/api/index.md | 17 ----------------- docs/api/logging.md | 2 +- docs/api/models/buffer.md | 2 +- docs/api/models/config.md | 2 +- docs/api/models/index.md | 2 +- docs/api/models/mixins.md | 2 +- docs/api/models/models.md | 2 +- docs/api/models/sdcard.md | 2 +- docs/api/models/stream.md | 2 +- docs/api/plots/headers.md | 2 +- docs/api/plots/index.md | 2 +- docs/api/stream_daq.md | 2 +- docs/api/utils.md | 2 +- docs/api/vendor/index.md | 2 +- docs/api/vendor/opalkelly.md | 2 +- docs/guide/index.md | 6 ------ docs/guide/usage.md | 7 +++++-- docs/index.md | 29 +++++++++++++++++++---------- docs/meta/index.md | 9 --------- 25 files changed, 44 insertions(+), 64 deletions(-) delete mode 100644 docs/api/index.md delete mode 100644 docs/guide/index.md delete mode 100644 docs/meta/index.md diff --git a/README.md b/README.md index 4d676108..a0ad48ab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # miniscope-io -![PyPI - Version](https://img.shields.io/pypi/v/miniscope-io) +[![PyPI - Version](https://img.shields.io/pypi/v/miniscope-io)](https://pypi.org/project/miniscope_io/) [![Documentation Status](https://readthedocs.org/projects/miniscope-io/badge/?version=latest)](https://miniscope-io.readthedocs.io/en/latest/?badge=latest) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/miniscope-io) ![PyPI - Status](https://img.shields.io/pypi/status/miniscope-io) diff --git a/docs/api/data.md b/docs/api/data.md index 4717d2c3..9c8524ab 100644 --- a/docs/api/data.md +++ b/docs/api/data.md @@ -1,4 +1,4 @@ -# Data +# data ```{eval-rst} .. automodule:: miniscope_io.data diff --git a/docs/api/devices.md b/docs/api/devices.md index 74068031..11af9ae1 100644 --- a/docs/api/devices.md +++ b/docs/api/devices.md @@ -1,4 +1,4 @@ -# Devices +# devices Interfaces to external devices like miniscopes and DAQs diff --git a/docs/api/formats/index.md b/docs/api/formats/index.md index a86ad04f..0f181006 100644 --- a/docs/api/formats/index.md +++ b/docs/api/formats/index.md @@ -1,4 +1,4 @@ -# Formats +# formats ```{eval-rst} .. automodule:: miniscope_io.formats diff --git a/docs/api/formats/sdcard.md b/docs/api/formats/sdcard.md index ab252319..60971b8a 100644 --- a/docs/api/formats/sdcard.md +++ b/docs/api/formats/sdcard.md @@ -1,4 +1,4 @@ -# SDCard +# sdcard ```{eval-rst} .. automodule:: miniscope_io.formats.sdcard diff --git a/docs/api/formats/stream.md b/docs/api/formats/stream.md index d15d8fde..9cca38d0 100644 --- a/docs/api/formats/stream.md +++ b/docs/api/formats/stream.md @@ -1,4 +1,4 @@ -# Stream +# stream ```{eval-rst} .. automodule:: miniscope_io.formats.stream diff --git a/docs/api/index.md b/docs/api/index.md deleted file mode 100644 index 058a1ebe..00000000 --- a/docs/api/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# API - -```{toctree} -:caption: API - -data -devices -formats/index -io -logging -models/index -exceptions -plots/index -utils -stream_daq -vendor/index -``` \ No newline at end of file diff --git a/docs/api/logging.md b/docs/api/logging.md index f31eb46a..b7320c99 100644 --- a/docs/api/logging.md +++ b/docs/api/logging.md @@ -1,4 +1,4 @@ -# Logging +# logging ```{eval-rst} .. automodule:: miniscope_io.logging diff --git a/docs/api/models/buffer.md b/docs/api/models/buffer.md index f1c87b98..9ca4aec3 100644 --- a/docs/api/models/buffer.md +++ b/docs/api/models/buffer.md @@ -1,4 +1,4 @@ -# Buffer +# buffer ```{eval-rst} .. automodule:: miniscope_io.models.buffer diff --git a/docs/api/models/config.md b/docs/api/models/config.md index 5a64c230..4a450d93 100644 --- a/docs/api/models/config.md +++ b/docs/api/models/config.md @@ -1,4 +1,4 @@ -# Config +# config ```{eval-rst} .. automodule:: miniscope_io.models.config diff --git a/docs/api/models/index.md b/docs/api/models/index.md index a5fb27ed..cffb774f 100644 --- a/docs/api/models/index.md +++ b/docs/api/models/index.md @@ -1,4 +1,4 @@ -# Models +# models Pydantic models used throughout `miniscope_io`. diff --git a/docs/api/models/mixins.md b/docs/api/models/mixins.md index fe712c2f..d892ea63 100644 --- a/docs/api/models/mixins.md +++ b/docs/api/models/mixins.md @@ -1,4 +1,4 @@ -# Mixins +# mixins ```{eval-rst} .. automodule:: miniscope_io.models.mixins diff --git a/docs/api/models/models.md b/docs/api/models/models.md index 1cfbc52c..916390ba 100644 --- a/docs/api/models/models.md +++ b/docs/api/models/models.md @@ -1,4 +1,4 @@ -# Models +# models ```{eval-rst} .. automodule:: miniscope_io.models.models diff --git a/docs/api/models/sdcard.md b/docs/api/models/sdcard.md index 52cbeae7..62958680 100644 --- a/docs/api/models/sdcard.md +++ b/docs/api/models/sdcard.md @@ -1,4 +1,4 @@ -# SDCard +# sdCard ```{eval-rst} .. automodule:: miniscope_io.models.sdcard diff --git a/docs/api/models/stream.md b/docs/api/models/stream.md index b4e6735b..dd45f77e 100644 --- a/docs/api/models/stream.md +++ b/docs/api/models/stream.md @@ -1,4 +1,4 @@ -# Stream +# stream ```{eval-rst} .. automodule:: miniscope_io.models.stream diff --git a/docs/api/plots/headers.md b/docs/api/plots/headers.md index 1b2d7f03..26c57635 100644 --- a/docs/api/plots/headers.md +++ b/docs/api/plots/headers.md @@ -1,4 +1,4 @@ -# Headers +# headers ```{eval-rst} .. automodule:: miniscope_io.plots.headers diff --git a/docs/api/plots/index.md b/docs/api/plots/index.md index e1a5ea1a..d1a73a47 100644 --- a/docs/api/plots/index.md +++ b/docs/api/plots/index.md @@ -1,4 +1,4 @@ -# Plots +# plots ```{toctree} :caption: Plots diff --git a/docs/api/stream_daq.md b/docs/api/stream_daq.md index f3abc658..d3e935fc 100644 --- a/docs/api/stream_daq.md +++ b/docs/api/stream_daq.md @@ -1,4 +1,4 @@ -# Stream DAQ +# stream_daq This module is a data acquisition module that captures video streams from Miniscopes based on the `Miniscope-SAMD-Framework` firmware. The firmware repository will be published in future updates but is currently under development and private. ## Command diff --git a/docs/api/utils.md b/docs/api/utils.md index 58f60245..f3939823 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -1,4 +1,4 @@ -# Utils +# utils ```{eval-rst} .. automodule:: miniscope_io.utils diff --git a/docs/api/vendor/index.md b/docs/api/vendor/index.md index d19bd380..910d7b07 100644 --- a/docs/api/vendor/index.md +++ b/docs/api/vendor/index.md @@ -1,4 +1,4 @@ -# Vendor +# vendor Modules that incorporate some proprietary/nonfree component and are vendored in diff --git a/docs/api/vendor/opalkelly.md b/docs/api/vendor/opalkelly.md index f3f69e45..f1a278e4 100644 --- a/docs/api/vendor/opalkelly.md +++ b/docs/api/vendor/opalkelly.md @@ -1,4 +1,4 @@ -# OpalKelly FrontPanel +# opalkelly (your docs on what this is for and how it works here!!!) diff --git a/docs/guide/index.md b/docs/guide/index.md deleted file mode 100644 index 66703634..00000000 --- a/docs/guide/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# Guide - -```{toctree} -installation -usage -``` \ No newline at end of file diff --git a/docs/guide/usage.md b/docs/guide/usage.md index 4d37bff4..b41cacf7 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -1,2 +1,5 @@ -```{include} ../api/stream_daq.md -``` \ No newline at end of file +# Usage + +## Stream Daq + +(see [stream_daq](../api/stream_daq.md)) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 9692f734..be3b3066 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,27 +1,36 @@ -.. miniscope-io documentation master file, created by - sphinx-quickstart on Tue Jun 27 10:52:50 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - # miniscope-io ```{toctree} :caption: Guide: +:maxdepth: 2 -guide/index +guide/installation +guide/usage ``` ```{toctree} :maxdepth: 2 -:caption: Contents: - -api/index +:caption: API: + +api/data +api/devices +api/formats/index +api/io +api/logging +api/models/index +api/exceptions +api/plots/index +api/utils +api/stream_daq +api/vendor/index ``` ```{toctree} :caption: Meta: -meta/index +meta/changelog +meta/contributing +meta/todo ``` diff --git a/docs/meta/index.md b/docs/meta/index.md deleted file mode 100644 index 6fbe2f42..00000000 --- a/docs/meta/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Meta - - -```{toctree} -changelog -contributing -todo -``` -