Skip to content

Commit

Permalink
Change readthedocs links to stable. (#255)
Browse files Browse the repository at this point in the history
  • Loading branch information
delucchi-cmu authored Apr 11, 2024
1 parent 4a1d213 commit 10e527d
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# For explanation of this file and uses see
# https://git-scm.com/docs/gitattributes
# https://developer.lsst.io/git/git-lfs.html#using-git-lfs-enabled-repositories
# https://lincc-ppt.readthedocs.io/en/latest/practices/git-lfs.html
# https://lincc-ppt.readthedocs.io/en/stable/practices/git-lfs.html
#
# Used by https://github.com/lsst/afwdata.git
# *.boost filter=lfs diff=lfs merge=lfs -text
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pre-commit-ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This workflow runs pre-commit hooks on pushes and pull requests to main
# to enforce coding style. To ensure correct configuration, please refer to:
# https://lincc-ppt.readthedocs.io/en/latest/practices/ci_precommit.html
# https://lincc-ppt.readthedocs.io/en/stable/practices/ci_precommit.html
name: Run pre-commit hooks

on:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/smoke-test.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This workflow will run daily at 06:45.
# It will install Python dependencies and run tests with a variety of Python versions.
# See documentation for help debugging smoke test issues:
# https://lincc-ppt.readthedocs.io/en/latest/practices/ci_testing.html#version-culprit
# https://lincc-ppt.readthedocs.io/en/stable/practices/ci_testing.html#version-culprit

name: Unit test smoke test

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# HiPSCat

[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)
[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/stable/)

[![PyPI](https://img.shields.io/pypi/v/hipscat?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/hipscat/)
[![Conda](https://img.shields.io/conda/vn/conda-forge/hipscat.svg?color=blue&logo=condaforge&logoColor=white)](https://anaconda.org/conda-forge/hipscat)
Expand All @@ -18,21 +18,21 @@ A HiPSCat catalog is a partitioning of objects on a sphere. Its purpose is for
storing data from large astronomy surveys, but could probably be used for other
use cases where you have large data with some spherical properties.

Check out our [ReadTheDocs site](https://hipscat.readthedocs.io/en/latest/)
Check out our [ReadTheDocs site](https://hipscat.readthedocs.io/en/stable/)
for more information on partitioning, installation, and contributing.

See related projects:

* HiPSCat Import ([on GitHub](https://github.com/astronomy-commons/hipscat-import))
([on ReadTheDocs](https://hipscat-import.readthedocs.io/en/latest/))
([on ReadTheDocs](https://hipscat-import.readthedocs.io/en/stable/))
* LSDB ([on GitHub](https://github.com/astronomy-commons/lsdb))
([on ReadTheDocs](https://lsdb.readthedocs.io/en/latest/))
([on ReadTheDocs](https://lsdb.readthedocs.io/en/stable/))

## Contributing

[![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/astronomy-commons/hipscat?color=purple&label=Good%20first%20issues&query=is%3Aopen%20label%3A%22good%20first%20issue%22)](https://github.com/astronomy-commons/hipscat/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

See the [contribution guide](https://hipscat.readthedocs.io/en/latest/guide/contributing.html)
See the [contribution guide](https://hipscat.readthedocs.io/en/stable/guide/contributing.html)
for completed installation instructions and contribution best practices.

## Acknowledgements
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ Notes:
2) ``pre-commit install`` will initialize pre-commit for this local repository, so
that a set of tests will be run prior to completing a local commit. For more
information, see the Python Project Template documentation on
`pre-commit <https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html>`_.
`pre-commit <https://lincc-ppt.readthedocs.io/en/stable/practices/precommit.html>`_.
3) Install ``pandoc`` allows you to verify that automatic rendering of Jupyter notebooks
into documentation for ReadTheDocs works as expected. For more information, see
the Python Project Template documentation on
`Sphinx and Python Notebooks <https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks>`_.
`Sphinx and Python Notebooks <https://lincc-ppt.readthedocs.io/en/stable/practices/sphinx.html#python-notebooks>`_.

.. tip::
Installing on Mac
Expand Down

0 comments on commit 10e527d

Please sign in to comment.