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.

Sign up for GitHub

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

Enable mkdocs strict mode to catch broken links #542

Merged
merged 2 commits into from
Apr 26, 2024
Merged

Enable mkdocs strict mode to catch broken links #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c213c0
Enable mkdocs strict mode to catch broken links
mfisher87 Apr 20, 2024
c06908a
Fixup mkdocs broken links
mfisher87 Apr 25, 2024
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 7 additions & 3 deletions docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
The Glossary section contains definitions for NASA terminology and Cloud computing.
3 changes: 3 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading