Skip to content

Commit

Permalink
fix: sphinx build warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
helen-m-lin committed Jul 19, 2024
1 parent fbfd957 commit e105b68
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions docs/source/ExamplesDocDBDirectConnection.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Examples - DocDB Direct Connection
==========
==================================

This page provides examples for interact with the Document Database (DocDB)
using the provided Python client.
Expand All @@ -12,7 +12,7 @@ Querying Metadata
~~~~~~~~~~~~~~~~~~~~~~

Count Example 1: Get # of records with a certain subject_id
------------------
-----------------------------------------------------------

.. code:: python
Expand All @@ -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
Expand Down Expand Up @@ -62,7 +62,7 @@ With projection (recommended):
Filter Example 2: Get records with a certain breeding group
------------------
-----------------------------------------------------------

.. code:: python
Expand Down Expand Up @@ -97,7 +97,7 @@ With projection (recommended):
print(json.dumps(records, indent=3))
Aggregation Example 1: Get all subjects per breeding group
------------------
----------------------------------------------------------

.. code:: python
Expand Down
6 changes: 3 additions & 3 deletions docs/source/UserGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit e105b68

Please sign in to comment.