Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor docs fixups #44

Merged
merged 3 commits into from
Jun 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/api-reference/index.rst
Original file line number Diff line number Diff line change
@@ -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::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/faq/cost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/for-developers/build-docs-sphinx.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/for-developers/manage-dependencies-poetry.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
15 changes: 11 additions & 4 deletions docs/source/for-developers/release-new-version.md
Original file line number Diff line number Diff line change
@@ -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".
Expand All @@ -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.

Expand Down
5 changes: 3 additions & 2 deletions docs/source/for-developers/setup-environment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# 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.

Expand Down
5 changes: 3 additions & 2 deletions docs/source/one-time-setup/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down