From f7ed05a6c5456030a256ce9bd2c8642b94e4bf90 Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Sat, 29 Jun 2024 23:02:05 -0700 Subject: [PATCH 1/3] minor fixups --- docs/source/api-reference/index.rst | 3 ++- docs/source/faq/cost.rst | 2 +- docs/source/for-developers/add-new-schema.md | 0 docs/source/for-developers/build-docs-sphinx.md | 2 +- .../for-developers/manage-dependencies-poetry.md | 2 +- docs/source/for-developers/release-new-version.md | 15 +++++++++++---- docs/source/for-developers/setup-environment.md | 4 ++-- docs/source/one-time-setup/install.rst | 5 +++-- 8 files changed, 21 insertions(+), 12 deletions(-) create mode 100644 docs/source/for-developers/add-new-schema.md diff --git a/docs/source/api-reference/index.rst b/docs/source/api-reference/index.rst index 32b8fd3..ce3c81b 100644 --- a/docs/source/api-reference/index.rst +++ b/docs/source/api-reference/index.rst @@ -1,7 +1,8 @@ pittgoogle ========== -.. These are from the ___init__.py file. Would be nice to find a way to pull them in automatically. +.. These are from the ___init__.py file. Would be nice to find a way to pull them in automatically +.. and also to make them hyperlinks. .. autosummary:: diff --git a/docs/source/faq/cost.rst b/docs/source/faq/cost.rst index 8ea4546..0892005 100644 --- a/docs/source/faq/cost.rst +++ b/docs/source/faq/cost.rst @@ -7,7 +7,7 @@ The Pitt-Google Alert Broker makes data available in Google Cloud repositories. The data are public and user-pays, meaning that anyone can access as much or little as they want, and everyone pays for what *they* use. Making the data available in this way can allow us to support a very large number of users. Payment goes to Google (not Pitt-Google Broker). -All authentication and billing is managed through Google Cloud projects. +All authentication and billing is managed through :ref:`projects`. Compared to more traditional computing costs, cloud charges are much smaller but more frequent. Some example charges are given in the table below. diff --git a/docs/source/for-developers/add-new-schema.md b/docs/source/for-developers/add-new-schema.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/for-developers/build-docs-sphinx.md b/docs/source/for-developers/build-docs-sphinx.md index fc137bf..93eed3d 100644 --- a/docs/source/for-developers/build-docs-sphinx.md +++ b/docs/source/for-developers/build-docs-sphinx.md @@ -1,4 +1,4 @@ -# Build Documentation with Sphinx +# Build documentation with Sphinx This page describes how to build documentation locally for testing. This is not always needed. diff --git a/docs/source/for-developers/manage-dependencies-poetry.md b/docs/source/for-developers/manage-dependencies-poetry.md index 49c7437..95050e2 100644 --- a/docs/source/for-developers/manage-dependencies-poetry.md +++ b/docs/source/for-developers/manage-dependencies-poetry.md @@ -1,4 +1,4 @@ -# Managing Dependencies with Poetry +# Managing dependencies with Poetry This page contains instructions for managing the `pittgoogle` package dependencies using [Poetry](https://python-poetry.org/). Poetry was implemented in this repo in [pull #7](https://github.com/mwvgroup/pittgoogle-client/pull/7). diff --git a/docs/source/for-developers/release-new-version.md b/docs/source/for-developers/release-new-version.md index 304ebd6..93e3a87 100644 --- a/docs/source/for-developers/release-new-version.md +++ b/docs/source/for-developers/release-new-version.md @@ -1,10 +1,17 @@ -# Release a New Version of pittgoogle-client +# Release a new version of the `pittgoogle-client` package -When you are ready to release a new version of `pittgoogle-client`, publish to PyPI using the following steps: +This page shows how to release a new version of `pittgoogle-client. +By following these instructions, you will: + +- Tag a new release on GitHub. +- Publish a new version to PyPI. +- Publish new documentation. + +## Instructions 1. Make sure the code in the main branch is ready for release. -2. Make sure the CHANGELOG.md file has been updated to reflect the changes being released. +2. Make sure the CHANGELOG.md file has been updated to include all changes being released. 3. On the repo's GitHub [releases](https://github.com/mwvgroup/pittgoogle-client/releases) page: - Click "Draft a new release". @@ -16,7 +23,7 @@ When you are ready to release a new version of `pittgoogle-client`, publish to P Completing step 3 will: -- Execute the test suite. +- Tag a new version on GitHub. - Publish the documentation to GitHub pages. - Publish the package to PyPI.org. diff --git a/docs/source/for-developers/setup-environment.md b/docs/source/for-developers/setup-environment.md index 1e14147..d6f5908 100644 --- a/docs/source/for-developers/setup-environment.md +++ b/docs/source/for-developers/setup-environment.md @@ -1,6 +1,6 @@ -# Set up and Use a Developer Environment +# Set up and use a developer environment -Instructions for setting up an environment with `pittgoogle` installed in development or "editable" mode are given below. +Instructions for setting up an environment with `pittgoogle-client` installed in development or "editable" mode are given below. This is a method of pip-installing the package from your local files so that you have quick access to your changes as you develop code. diff --git a/docs/source/one-time-setup/install.rst b/docs/source/one-time-setup/install.rst index 2caa629..2e512ec 100644 --- a/docs/source/one-time-setup/install.rst +++ b/docs/source/one-time-setup/install.rst @@ -5,13 +5,14 @@ Install pittgoogle-client .. automodule:: pittgoogle -The basic install command is (conda recommended; see below): +Use of a conda environment is recommended (see below). +The basic install command is: .. code-block:: bash pip install pittgoogle-client -This is imported in python as: +The package is imported in python as: .. code-block:: python From 002ba3b3fd7c747984813c8166de67ccf898a880 Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Sat, 29 Jun 2024 23:25:13 -0700 Subject: [PATCH 2/3] fixup! minor fixups --- docs/source/for-developers/add-new-schema.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 docs/source/for-developers/add-new-schema.md diff --git a/docs/source/for-developers/add-new-schema.md b/docs/source/for-developers/add-new-schema.md deleted file mode 100644 index e69de29..0000000 From e5be693698f6d610a5656b63f5665a15822c4ba7 Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Sat, 29 Jun 2024 23:30:29 -0700 Subject: [PATCH 3/3] fixup! fixup! minor fixups --- docs/source/for-developers/setup-environment.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/for-developers/setup-environment.md b/docs/source/for-developers/setup-environment.md index d6f5908..aa9a125 100644 --- a/docs/source/for-developers/setup-environment.md +++ b/docs/source/for-developers/setup-environment.md @@ -1,6 +1,7 @@ # Set up and use a developer environment -Instructions for setting up an environment with `pittgoogle-client` installed in development or "editable" mode are given below. +Instructions for setting up an environment with `pittgoogle-client` installed in development or "editable" +mode are given below. This is a method of pip-installing the package from your local files so that you have quick access to your changes as you develop code.