minor docs updates

mwvgroup · Jun 29, 2024 · 6dcf8fe · 6dcf8fe
1 parent cfec881
commit 6dcf8fe
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 28 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,41 +3,33 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+pittgoogle-client
+=================
+
+`pittgoogle-client` is a python library for accessing astronomy data served by
+`Pitt-Google Alert Broker <https://github.com/mwvgroup/Pitt-Google-Broker>`__.
+Tutorials and examples can be found at
+`Pitt-Google User Demos <https://github.com/mwvgroup/pittgoogle-user-demos>`__.
+If you run into trouble, please
+`open an Issue <https://github.com/mwvgroup/pittgoogle-client/issues>`__.
+
 .. toctree::
-    :maxdepth: 3
-    :hidden:
+    :caption: Overview
+    :maxdepth: 1
 
     main/listings
     Install<main/one-time-setup/install>
     main/one-time-setup/index
     main/faq/index
-
-.. toctree::
-    :caption: For Developers
-    :maxdepth: 3
-    :hidden:
-
-    for-developers/setup-environment
-    for-developers/manage-dependencies-poetry
-    for-developers/release-new-version
+    main/for-developers/index
 
 .. toctree::
     :caption: API Reference
-    :maxdepth: 3
-    :hidden:
+    :maxdepth: 1
 
     api-reference/auth
     api-reference/bigquery
     api-reference/exceptions
     api-reference/pubsub
     api-reference/registry
     api-reference/utils
-
-pittgoogle-client
-=================
-
-`pittgoogle-client` is a python library for accessing astronomy data served by
-`Pitt-Google Alert Broker <https://github.com/mwvgroup/Pitt-Google-Broker>`__.
-
-If you run into trouble, please
-`open an Issue <https://github.com/mwvgroup/pittgoogle-client/issues>`__.
diff --git a/docs/source/main/faq/index.rst b/docs/source/main/faq/index.rst
@@ -2,7 +2,7 @@ Frequently Asked Questions
 ==============================================
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
 
     cost
     find-project-id
diff --git a/docs/source/main/for-developers/build-docs-sphinx.md b/docs/source/main/for-developers/build-docs-sphinx.md
@@ -18,6 +18,7 @@ poetry install --with=docs
 cd docs  # assuming we started in the repo root directory
 
 # Build the documentation
+make clean
 make html
 ```
 

diff --git a/docs/source/main/for-developers/index.rst b/docs/source/main/for-developers/index.rst
@@ -4,7 +4,7 @@ For Developers
 .. toctree::
     :maxdepth: 1
 
-    for-developers/setup-environment
-    for-developers/manage-dependencies-poetry
-    for-developers/build-docs-sphinx
-    for-developers/release-new-version
+    setup-environment
+    manage-dependencies-poetry
+    build-docs-sphinx
+    release-new-version
diff --git a/docs/source/main/one-time-setup/index.rst b/docs/source/main/one-time-setup/index.rst
@@ -6,7 +6,7 @@ One-Time Setup
 Using pittgoogle-client to interact with cloud resources requires the following one-time setup tasks:
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
 
     Install pittgoogle-client<install>
     Setup a Google Cloud Project<project>