From e105b6845bac54ad8b4862fab5a63fdb01a0bbeb Mon Sep 17 00:00:00 2001 From: Helen Lin Date: Fri, 19 Jul 2024 11:56:30 -0700 Subject: [PATCH] fix: sphinx build warnings --- docs/source/ExamplesDocDBDirectConnection.rst | 10 +++++----- docs/source/UserGuide.rst | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/ExamplesDocDBDirectConnection.rst b/docs/source/ExamplesDocDBDirectConnection.rst index e040d26..9cf0437 100644 --- a/docs/source/ExamplesDocDBDirectConnection.rst +++ b/docs/source/ExamplesDocDBDirectConnection.rst @@ -1,5 +1,5 @@ Examples - DocDB Direct Connection -========== +================================== This page provides examples for interact with the Document Database (DocDB) using the provided Python client. @@ -12,7 +12,7 @@ Querying Metadata ~~~~~~~~~~~~~~~~~~~~~~ Count Example 1: Get # of records with a certain subject_id ------------------- +----------------------------------------------------------- .. code:: python @@ -30,7 +30,7 @@ Count Example 1: Get # of records with a certain subject_id print(count) Filter Example 1: Get records with a certain subject_id ------------------- +------------------------------------------------------- .. code:: python @@ -62,7 +62,7 @@ With projection (recommended): Filter Example 2: Get records with a certain breeding group ------------------- +----------------------------------------------------------- .. code:: python @@ -97,7 +97,7 @@ With projection (recommended): print(json.dumps(records, indent=3)) Aggregation Example 1: Get all subjects per breeding group ------------------- +---------------------------------------------------------- .. code:: python diff --git a/docs/source/UserGuide.rst b/docs/source/UserGuide.rst index c214801..c59c417 100644 --- a/docs/source/UserGuide.rst +++ b/docs/source/UserGuide.rst @@ -12,7 +12,7 @@ We have two primary databases: 2. A `relational database <#rds-tables>`__ to store structured tables. Document Database (DocDB) --------------------- +------------------------- AIND metadata records stored in the DocDB describe the ``metadata.nd.json`` for a data asset: @@ -75,7 +75,7 @@ REST API (Read-Only) Direct Connection (SSH) - Database UI (MongoDB Compass) -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ MongoDB Compass is a database GUI that can be used to query and interact with our document database. @@ -141,7 +141,7 @@ To connect: ) Direct Connection (SSH) - Python Client -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ We have some convenience methods to interact with our Document Store. You can create a client by explicitly setting credentials, or downloading from AWS Secrets Manager.