Skip to content

Commit 32497c5

Browse files
committed
docs: enable URLs to display as clickable links.
1 parent c6370ae commit 32497c5

29 files changed

+65
-65
lines changed

docs/api/01meta.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ General topics not specific to any particular endpoint are discussed in the
2222

2323
# The API
2424

25-
The base URL is: https://api.delphi.cmu.edu/epidata/meta/
25+
The base URL is: <https://api.delphi.cmu.edu/epidata/meta/>
2626

2727
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
2828

@@ -41,7 +41,7 @@ None.
4141

4242
# Example URLs
4343

44-
https://api.delphi.cmu.edu/epidata/meta/
44+
<https://api.delphi.cmu.edu/epidata/meta/>
4545

4646
```json
4747
{

docs/api/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ like to cite it, we would gratefully recommend the following copy:
4040
> Roni Rosenfeld
4141
> (2015).
4242
> _Delphi Epidata API_.
43-
> https://github.com/cmu-delphi/delphi-epidata
43+
> <https://github.com/cmu-delphi/delphi-epidata>
4444
4545
## Data Licensing
4646

@@ -71,7 +71,7 @@ Please note that our `endpoint` parameters were previously referenced as `source
7171

7272
# The API
7373

74-
The base URL is: https://api.delphi.cmu.edu/epidata/
74+
The base URL is: <https://api.delphi.cmu.edu/epidata/>
7575

7676
## Specifying Epiweeks, Dates, and Lists
7777

@@ -153,7 +153,7 @@ The parameters available for each source are documented in each linked source-sp
153153
# Example URLs
154154

155155
### FluView on 2015w01 (national)
156-
https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
156+
<https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501>
157157

158158
```json
159159
{
@@ -183,7 +183,7 @@ https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
183183
```
184184

185185
### Wikipedia Access article "influenza" on 2020w01
186-
https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks=202001
186+
<https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks=202001>
187187

188188
```json
189189
{

docs/api/cdc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ General topics not specific to any particular endpoint are discussed in the
4040

4141
# The API
4242

43-
The base URL is: https://api.delphi.cmu.edu/epidata/cdc/
43+
The base URL is: <https://api.delphi.cmu.edu/epidata/cdc/>
4444

4545
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
4646

@@ -77,7 +77,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
7777
# Example URLs
7878

7979
### CDC Page Hits on 2015w01 (national)
80-
https://api.delphi.cmu.edu/epidata/cdc/?auth=...&locations=nat&epiweeks=201501
80+
<https://api.delphi.cmu.edu/epidata/cdc/?auth=...&locations=nat&epiweeks=201501>
8181

8282
```json
8383
{

docs/api/covid_hosp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ General topics not specific to any particular data source are discussed in the
5353

5454
# The API
5555

56-
The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/
56+
The base URL is: <https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/>
5757

5858
See [this documentation](README.md) for details on specifying locations and dates.
5959

@@ -89,7 +89,7 @@ If `issues` is not specified, then the most recent issue is used by default.
8989
# Example URLs
9090

9191
### MA on 2020-05-10 (per most recent issue)
92-
https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=20200510
92+
<https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=20200510>
9393

9494
```json
9595
{

docs/api/covid_hosp_facility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ General topics not specific to any particular data source are discussed in the
4747

4848
# The API
4949

50-
The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_facility/
50+
The base URL is: <https://api.delphi.cmu.edu/epidata/covid_hosp_facility/>
5151

5252
See [this documentation](README.md) for details on specifying locations and dates.
5353

@@ -97,7 +97,7 @@ has been renamed here for clarity.
9797
# Example URLs
9898

9999
### Moses Taylor Hospital (Scranton, PA) on the first collection week of December 2020 (per most recent issue)
100-
https://api.delphi.cmu.edu/epidata/covid_hosp_facility/?hospital_pks=390119&collection_weeks=20201201-20201207
100+
<https://api.delphi.cmu.edu/epidata/covid_hosp_facility/?hospital_pks=390119&collection_weeks=20201201-20201207>
101101

102102
```json
103103
{

docs/api/covid_hosp_facility_lookup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ General topics not specific to any particular data source are discussed in the
4343

4444
# The API
4545

46-
The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/
46+
The base URL is: <https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/>
4747

4848
See [this documentation](README.md) for details on specifying locations and dates.
4949

@@ -88,7 +88,7 @@ Use the `hospital_pk` value when querying
8888
# Example URLs
8989

9090
### Lookup facilities in the city of Southlake (TX)
91-
https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/?city=southlake
91+
<https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/?city=southlake>
9292

9393
```json
9494
{

docs/api/covidcast-signals/nchs-mortality.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ We report the NCHS Mortality data in a weekly format (`time_type=week` &
6969
`time_value={YYYYWW}`, where `YYYYWW` refers to an epiweek). The CDC defines
7070
the [epiweek](https://web.archive.org/web/20210623224758/https://wwwn.cdc.gov/nndss/document/MMWR_Week_overview.pdf) as
7171
seven days, from Sunday to Saturday. We check the week-ending dates provided in
72-
the NCHS morality data and use Python package
72+
the NCHS mortality data and use Python package
7373
[epiweeks](https://pypi.org/project/epiweeks/) to convert them into epiweek
7474
format.
7575

docs/api/covidcast_api_queries.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav_order: 4
66
# Constructing API Queries
77

88
The COVIDcast API is based on HTTP GET queries and returns data in JSON form.
9-
The base URL is `https://api.delphi.cmu.edu/epidata/covidcast/`.
9+
The base URL is <https://api.delphi.cmu.edu/epidata/covidcast/>.
1010

1111
See [this documentation](README.md) for details on specifying epiweeks, dates,
1212
and lists.
@@ -131,11 +131,11 @@ The `fields` parameter can be used to limit which fields are included in each re
131131

132132
## Facebook Survey CLI on 2020-04-06 to 2010-04-10 (county 06001)
133133

134-
https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406-20200410&geo_value=06001
134+
<https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406-20200410&geo_value=06001>
135135

136136
or
137137

138-
https://api.delphi.cmu.edu/epidata/covidcast/?signal=fb-survey:smoothed_cli&time=day:20200406-20200410&geo=county:06001
138+
<https://api.delphi.cmu.edu/epidata/covidcast/?signal=fb-survey:smoothed_cli&time=day:20200406-20200410&geo=county:06001>
139139

140140
Both of these URLs are equivalent and can be used to get the following result:
141141

@@ -159,7 +159,7 @@ Both of these URLs are equivalent and can be used to get the following result:
159159

160160
## Facebook Survey CLI on 2020-04-06 (all counties)
161161

162-
https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406&geo_value=*
162+
<https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406&geo_value=*>
163163

164164
```json
165165
{

docs/api/covidcast_meta.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ geographic levels at which they are reported.
1414

1515
## The API
1616

17-
The base URL is: https://api.delphi.cmu.edu/epidata/covidcast_meta/
17+
The base URL is: <https://api.delphi.cmu.edu/epidata/covidcast_meta/>
1818

1919
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
2020

@@ -47,7 +47,7 @@ None required.
4747

4848
## Example URLs
4949

50-
https://api.delphi.cmu.edu/epidata/covidcast_meta/
50+
<https://api.delphi.cmu.edu/epidata/covidcast_meta/>
5151

5252
```json
5353
{

docs/api/delphi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ General topics not specific to any particular endpoint are discussed in the
3838

3939
# The API
4040

41-
The base URL is: https://api.delphi.cmu.edu/epidata/delphi/
41+
The base URL is: <https://api.delphi.cmu.edu/epidata/delphi/>
4242

4343
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
4444

@@ -81,7 +81,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
8181
# Example URLs
8282

8383
### Delphi on 2015w01 (EC)
84-
https://api.delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=201501
84+
<https://api.delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=201501>
8585

8686
```json
8787
{

0 commit comments

Comments
 (0)