From 3c213c03962bfb32c6cad7778b4afd2ce6a90df0 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Fri, 19 Apr 2024 18:04:47 -0600 Subject: [PATCH 1/2] Enable mkdocs strict mode to catch broken links --- mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index fd9c3331..ca5877bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,9 @@ site_name: earthaccess site_description: Client library for NASA Earthdata APIs site_url: https://github.com/nsidc/earthaccess +# Fail on broken links +strict: true + theme: name: "material" logo: earth.png From c06908ae8f622a7c4a12772b37b110050e99e226 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Wed, 24 Apr 2024 20:35:13 -0600 Subject: [PATCH 2/2] Fixup mkdocs broken links --- README.md | 2 +- docs/quick-start.md | 10 +++++++--- docs/user_guide/index.md | 8 ++++---- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8eea0480..d9bfb9a4 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ Only **Python 3.8+** is supported. ## How to Contribute to `earthaccess` -If you want to find out how to contribute to `earthaccess` checkout the [Contributing Guide](https://earthaccess.readthedocs.io/en/latest/contributing/). +If you want to contribute to `earthaccess` checkout the [Contributing Guide](https://earthaccess.readthedocs.io/en/latest/contributing/). ### Contributors diff --git a/docs/quick-start.md b/docs/quick-start.md index 6dc2cce4..38545302 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -44,8 +44,12 @@ Type "help", "copyright", "credits" or "license" for more information. ## **Get Data in 3 Steps** -`earthaccess` allows you to search for and access data in as little as three steps. We give a very quick example below. These three steps allow you to get data whether you are working in the cloud or on your local laptop or workstation. Read the [User Guide](user_guide.qmd) for more information. If you want to quickly find how to perform some common searches and data access, -take a look at our [How-to](how_to.qmd) guide. +`earthaccess` allows you to search for and access data in as little as three steps. We +give a very quick example below. These three steps allow you to get data whether you +are working in the cloud or on your local laptop or workstation. Read the +[User Guide](user_guide/index.md) for more information. If you want to quickly find how +to perform some common searches and data access, take a look at our how-to guides in the +sidebar. The only requirement to use this library is to open a free account with NASA [EDL](https://urs.earthdata.nasa.gov). @@ -54,7 +58,7 @@ The only requirement to use this library is to open a free account with NASA [ED To access NASA data, you have to login using your Earth Data Login credentials. You can register for a free Earth Data Login account [here](https://urs.earthdata.nasa.gov/). By default, `earthaccess` will look for your Earth Data Login credentials in a `.netrc` file, or in environment variables `EARTHDATA_USERNAME` and `EARTHDATA_PASSWORD`. If you don't -have either of these set up, you can login manually. See [Authenticating](authenticate.qmd) to learn how to create a `.netrc` file or environment variables. +have either of these set up, you can login manually. See [Authenticating](howto/authenticate.md) to learn how to create a `.netrc` file or environment variables. ``` import earthaccess diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md index aed94d5e..4688bdeb 100644 --- a/docs/user_guide/index.md +++ b/docs/user_guide/index.md @@ -2,12 +2,12 @@ `earthaccess` enables authentication, search and access for NASA Earth science data. The package enables users to find, and download or stream data archived both at NASA DAACs and in the AWS-hosted Earthdata Cloud. The User Guide introduces these three functions. -The [Authentication](user_guide/authentication.md) section shows how `earthaccess` can be used to manage Earth Data Login and also Earthdata Cloud credentials. +The [Authentication](/user_guide/authentication.md) section shows how `earthaccess` can be used to manage Earth Data Login and also Earthdata Cloud credentials. -The [Search](user_guide/search.md) section introduces how to search for NASA datasets (collections) and specific data granules. +The [Search](/user_guide/search.md) section introduces how to search for NASA datasets (collections) and specific data granules. -The [Access](user_guide/access.md) section introduces how to use `earthaccess` to download data to a local machine or stream data by opening it directly in memory. +The [Access](/user_guide/access.md) section introduces how to use `earthaccess` to download data to a local machine or stream data by opening it directly in memory. Additional usage information can be found in the User Reference section. The How-To sections contains short code examples for specific workflows. Longer tutorials for working with particular datasets are in the Tutorials section. -The Glossary section contains definitions for NASA terminology and Cloud computing. \ No newline at end of file +The Glossary section contains definitions for NASA terminology and Cloud computing.