Skip to content

Commit

Permalink
Documentation: Adjust URLs to RTD
Browse files Browse the repository at this point in the history
Use https://herbie.readthedocs.io/ across the board.
  • Loading branch information
amotl committed Jan 9, 2023
1 parent 01ad920 commit 04c6a3f
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 26 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ authors:
title: "Herbie: Retrieve Numerical Weather Prediction Model Data"
version: 2022.9.0
date-released: "2022-05-06"
url: "https://blaylockbk.github.io/Herbie/_build/html/"
url: "https://herbie.readthedocs.io/"
repository-code: "https://github.com/blaylockbk/Herbie"
type: software
keywords:
Expand Down
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

![](https://img.shields.io/github/license/blaylockbk/Herbie)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Documentation Status](https://readthedocs.org/projects/herbie/badge/?version=latest)](https://herbie.readthedocs.io/?badge=latest)
[![Conda Recipe](https://img.shields.io/badge/recipe-herbie--data-green.svg)](https://anaconda.org/conda-forge/herbie-data)
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/herbie-data.svg)](https://anaconda.org/conda-forge/herbie-data)
[![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/herbie-data.svg)](https://anaconda.org/conda-forge/herbie-data)
Expand All @@ -26,16 +27,16 @@

Herbie helps you discover, download, and read data from:

- [High Resolution Rapid Refresh (HRRR)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/hrrr.html) | [HRRR-Alaska](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/hrrrak.html)
- [Rapid Refresh (RAP)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/rap.html)
- [Global Forecast System (GFS)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/gfs.html)
- [Global Ensemble Forecast System (GEFS)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/gefs.html)
- [ECMWF Open Data Forecast Products](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/ecmwf.html)
- [High Resolution Rapid Refresh (HRRR)](https://herbie.readthedocs.io/user_guide/_model_notebooks/hrrr.html) | [HRRR-Alaska](https://herbie.readthedocs.io/user_guide/_model_notebooks/hrrrak.html)
- [Rapid Refresh (RAP)](https://herbie.readthedocs.io/user_guide/_model_notebooks/rap.html)
- [Global Forecast System (GFS)](https://herbie.readthedocs.io/user_guide/_model_notebooks/gfs.html)
- [Global Ensemble Forecast System (GEFS)](https://herbie.readthedocs.io/user_guide/_model_notebooks/gefs.html)
- [ECMWF Open Data Forecast Products](https://herbie.readthedocs.io/user_guide/_model_notebooks/ecmwf.html)
- [North American Mesoscale Model (NAM)](https://github.com/blaylockbk/Herbie/blob/main/docs/user_guide/_model_notebooks/nam.ipynb)
- [National Blend of Models (NBM)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/nbm.html)
- [Rapid Refresh Forecast System - Prototype (RRFS)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/_model_notebooks/rrfs.html)
- [National Blend of Models (NBM)](https://herbie.readthedocs.io/user_guide/_model_notebooks/nbm.html)
- [Rapid Refresh Forecast System - Prototype (RRFS)](https://herbie.readthedocs.io/user_guide/_model_notebooks/rrfs.html)

# 📓 [Herbie Documentation](https://blaylockbk.github.io/Herbie/_build/html/)
# 📓 [Herbie Documentation](https://herbie.readthedocs.io/)

## Installation

Expand Down Expand Up @@ -174,7 +175,7 @@ If Herbie played an important role in your work, please [tell me about it](https

| | |
| :-: | ----------------------------------------------------------------------------------------------------- |
| 👨🏻‍💻 | [Contributing Guidelines](https://blaylockbk.github.io/Herbie/_build/html/user_guide/contribute.html) |
| 👨🏻‍💻 | [Contributing Guidelines](https://herbie.readthedocs.io/user_guide/contribute.html) |
| 💬 | [GitHub Discussions](https://github.com/blaylockbk/Herbie/discussions) |
| 🚑 | [GitHub Issues](https://github.com/blaylockbk/Herbie/issues) |
| 🌐 | [Personal Webpage](http://home.chpc.utah.edu/~u0553130/Brian_Blaylock/home.html) |
Expand Down
2 changes: 1 addition & 1 deletion docs/404.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

404: Page Not Found

[Back to Herbie docs](https://blaylockbk.github.io/Herbie/_build/html/)
[Back to Herbie docs](https://herbie.readthedocs.io/)
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ Some models Herbie can retrieve data from include:

.. TODO: I'd like to have the cards here instead of the toctree, but the toctree is needed to show the links in the top banner.
.. .. card:: User Guide
.. :link: https://blaylockbk.github.io/Herbie/_build/html/user_guide/index.html
.. :link: https://herbie.readthedocs.io/user_guide/index.html
.. Information you need to know to use Herbie.
.. .. card:: Reference Guide
.. :link: https://blaylockbk.github.io/Herbie/_build/html/reference_guide/index.html
.. :link: https://herbie.readthedocs.io/reference_guide/index.html
.. API reference for Herbie's classes and functions.
Expand Down
16 changes: 8 additions & 8 deletions docs/user_guide/_tutorial_notebooks/intro.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
"\n",
"Herbie can discover data for many different models and sources, including: \n",
"\n",
"- [High Resolution Rapid Refresh (HRRR)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_hrrr.html)\n",
"- [High Resolution Rapid Refresh - Alaska (HRRRAK)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_hrrrak.html)\n",
"- [Rapid Refresh (RAP)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_rap.html)\n",
"- [Global Forecast System (GFS)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_gfs.html)\n",
"- [Global Forecast System - Wave (GFS-Wave)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_gfs.html#Get-data-from-the-GFS-wave-output)\n",
"- [ECMWF Open Data Forecast Products (ECMWF)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_ecmwf.html)\n",
"- [National Blend of Models (NMB)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_nbm.html)\n",
"- [Rapid Refresh Forecast System - Prototype (RRFS)](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_rrfs.html)\n",
"- [High Resolution Rapid Refresh (HRRR)](https://herbie.readthedocs.io/user_guide/notebooks/data_hrrr.html)\n",
"- [High Resolution Rapid Refresh - Alaska (HRRRAK)](https://herbie.readthedocs.io/user_guide/notebooks/data_hrrrak.html)\n",
"- [Rapid Refresh (RAP)](https://herbie.readthedocs.io/user_guide/notebooks/data_rap.html)\n",
"- [Global Forecast System (GFS)](https://herbie.readthedocs.io/user_guide/notebooks/data_gfs.html)\n",
"- [Global Forecast System - Wave (GFS-Wave)](https://herbie.readthedocs.io/user_guide/notebooks/data_gfs.html#Get-data-from-the-GFS-wave-output)\n",
"- [ECMWF Open Data Forecast Products (ECMWF)](https://herbie.readthedocs.io/user_guide/notebooks/data_ecmwf.html)\n",
"- [National Blend of Models (NMB)](https://herbie.readthedocs.io/user_guide/notebooks/data_nbm.html)\n",
"- [Rapid Refresh Forecast System - Prototype (RRFS)](https://herbie.readthedocs.io/user_guide/notebooks/data_rrfs.html)\n",
"\n",
"This example shows how to create a Herbie object for the HRRR model `sfc` product and 6 hour forecast. The file was found an Amazon Web Services."
]
Expand Down
2 changes: 1 addition & 1 deletion herbie/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def _expand(self, resolve=False, absolute=False):
# Private Model Template
# ======================
# Find more details at
# https://blaylockbk.github.io/Herbie/_build/html/user_guide/extend.html
# https://herbie.readthedocs.io/user_guide/extend.html
# Uncomment class, add additional classes, and edit SOURCES dictionary
# to help Herbie locate your locally stored GRIB2 files.
Expand Down
4 changes: 2 additions & 2 deletions herbie/archive.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
`finish line <https://www.youtube.com/watch?v=4XWufUZ1mxQ&t=189s>`_.
Happy racing! 🏁
`📓 Documentation <https://blaylockbk.github.io/Herbie/_build/html/>`_
`📓 Documentation <https://herbie.readthedocs.io/>`_
With Herbie's API, you can search and download GRIB2 model output files
from different archive sources for the High-Resolution Rapid Refresh
Expand All @@ -33,7 +33,7 @@
Herbie is extendable to support other models. Simply create a template
file in the ``herbie/models`` directory and make a pull-request.
For more details, see https://blaylockbk.github.io/Herbie/_build/html/user_guide/data_sources.html
For more details, see https://herbie.readthedocs.io/user_guide/data_sources.html
TODO: Rename 'searchString' to 'subset' (and rename subset function to??) - REJECTED, for now
Expand Down
2 changes: 1 addition & 1 deletion notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

These notebooks are a reference for miscellaneous tasks. For examples using Herbie to access different types of NWP models, refer to the documentation:

## [More Herbie Examples](https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/index.html)
## [More Herbie Examples](https://herbie.readthedocs.io/user_guide/notebooks/index.html)
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ platform = any
url = https://github.com/blaylockbk/Herbie
project_urls =
Source Code = https://github.com/blaylockbk/Herbie
Documentation = https://blaylockbk.github.io/Herbie/_build/html/
Documentation = https://herbie.readthedocs.io/
Release Notes = https://github.com/blaylockbk/Herbie/releases
Bug Tracker = https://github.com/blaylockbk/Herbie/issues
keywords =
Expand Down

0 comments on commit 04c6a3f

Please sign in to comment.