Skip to content

Commit cc3d1b0

Browse files
authored
Merge pull request #76 from JuliaAstro/links
Links
2 parents d45422e + 84633c0 commit cc3d1b0

File tree

7 files changed

+82
-67
lines changed

7 files changed

+82
-67
lines changed

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
34
JuliaAstroDocs = "5ba9df79-bc07-467f-bade-66a1d49082bd"
45
MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c"
56
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"

docs/make.jl

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
1-
using Revise, MultiDocumenter, Documenter
1+
using Revise, MultiDocumenter, Documenter, DocumenterInterLinks
22
using LibGit2, Pkg, TOML, UUIDs, Downloads
33

44
Revise.revise()
55

66
import JuliaAstroDocs
77

8+
# Prefer online docs, use local as fallback
9+
links = InterLinks(
10+
"AstroImages" => (
11+
"https://juliaastro.org/AstroImages/dev/",
12+
"https://juliaastro.org/AstroImages/dev/objects.inv",
13+
joinpath(@__DIR__, "clones", "AstroImages", "dev", "objects.inv"),
14+
),
15+
"AstroLib" => (
16+
"https://juliaastro.org/AstroLib/stable/",
17+
"https://juliaastro.org/AstroLib/stable/objects.inv",
18+
joinpath(@__DIR__, "clones", "AstroLib", "dev", "objects.inv"),
19+
)
20+
)
21+
822
# This make file compiles the documentation for the JuliaAstro website.
923
# It consists of the usual documenter structure, but also follows the approach
1024
# of the SciML docs page https://github.com/SciML/SciMLDocs/blob/main/docs/make.jl
@@ -58,6 +72,7 @@ makedocs(
5872
"Comparison with Astropy" => "comparison.md",
5973
],
6074
warnonly = [:missing_docs],
75+
plugins = [links],
6176
)
6277

6378
@info "Building aggregate JuliaAstro site"

docs/src/ecosystem.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
1010

1111
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/AstroImages.jl)
1212

13-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/AstroImages.jl/stable/)
13+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/AstroImages/stable/)
1414

1515
**Load, manipulate, and visualize astronomical images**
1616

@@ -21,7 +21,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
2121

2222
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/CFITSIO.jl)
2323

24-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/FITSIO.jl/stable/)
24+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/CFITSIO/stable/)
2525

2626
**Reading and writing FITS files**
2727

@@ -33,7 +33,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
3333

3434
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/FITSIO.jl)
3535

36-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/FITSIO.jl/stable/)
36+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/FITSIO/stable/)
3737

3838
**Reading and writing FITS files**
3939

@@ -127,7 +127,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
127127

128128
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/AstroImages.jl)
129129

130-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/AstroImages.jl/stable/)
130+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/AstroImages/stable/)
131131

132132
**Load, manipulate, and visualize astronomical images**
133133

@@ -138,7 +138,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
138138

139139
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/CCDReduction.jl)
140140

141-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/CCDReduction.jl/stable/)
141+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/CCDReduction/stable/)
142142

143143
**Common CCD image processing routines**
144144

@@ -151,7 +151,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
151151

152152
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/LACosmic.jl)
153153

154-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/LACosmic.jl/stable/)
154+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/LACosmic/stable/)
155155

156156
**Cosmic-ray rejection by Laplacian edge detection**
157157

@@ -163,7 +163,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
163163

164164
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/Photometry.jl)
165165

166-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/Photometry.jl/stable/)
166+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/Photometry/stable/)
167167

168168
**Aperture photometry**
169169

@@ -175,7 +175,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
175175

176176
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/PSFModels.jl)
177177

178-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/PSFModels.jl/stable/)
178+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/PSFModels/stable/)
179179

180180
**Analytical, allocation-free point-spread-functions (PSF)**
181181

@@ -198,7 +198,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
198198

199199
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/SAOImageDS9.jl)
200200

201-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/SAOImageDS9.jl/stable/)
201+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/SAOImageDS9/stable/)
202202

203203
**Interface with the DS9 image viewer**
204204

@@ -241,7 +241,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
241241

242242
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/AstroAngles.jl)
243243

244-
[![book icon](assets/book.png) Documentation](https://juliaastro.org/AstroAngles.jl/dev/)
244+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/AstroAngles/stable/)
245245

246246
**String parsing and representation of angles**
247247

@@ -253,7 +253,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
253253

254254
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/AstroTime.jl)
255255

256-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/AstroTime.jl/stable/)
256+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/AstroTime/stable/)
257257

258258
**Astronomical time keeping**
259259

@@ -276,7 +276,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
276276

277277
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/SkyCoords.jl)
278278

279-
[![book icon](assets/book.png) Documentation](https://juliaastro.org/SkyCoords.jl/stable/)
279+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/SkyCoords/stable/)
280280

281281
**Astronomical coordinate systems**
282282

@@ -288,7 +288,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
288288

289289
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/SPICE.jl)
290290

291-
[![book icon](assets/book.png) Documentation](https://juliaastro.org/SPICE.jl/stable/)
291+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/SPICE/stable/)
292292

293293
**SPICE data retrieval and usage**
294294

@@ -300,7 +300,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
300300

301301
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/UnitfulAstro.jl)
302302

303-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/UnitfulAstro.jl/stable/)
303+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/UnitfulAstro/stable/)
304304

305305
**Astronomical units**
306306

@@ -311,7 +311,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
311311

312312
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/WCS.jl)
313313

314-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/WCS.jl/stable/)
314+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/WCS/stable/)
315315

316316
**World Coordinate System transformations**
317317

@@ -325,7 +325,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
325325

326326
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/EarthOrientation.jl)
327327

328-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/EarthOrientation.jl/stable/)
328+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/EarthOrientation/stable/)
329329

330330
**Earth orientation parameters**
331331

@@ -336,7 +336,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
336336

337337
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/Transits.jl)
338338

339-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/Transits.jl/stable/)
339+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/Transits/stable/)
340340

341341
**Flexible photometric transit curves with limb darkening**
342342

@@ -395,7 +395,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
395395

396396
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/astrolib.jl)
397397

398-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/AstroLib.jl/stable/)
398+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/AstroLib/stable/)
399399

400400
**Collection of generic astronomical and astrophysical functions**
401401

@@ -406,7 +406,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
406406

407407
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/BoxLeastSquares.jl)
408408

409-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/BoxLeastSquares.jl/stable/)
409+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/BoxLeastSquares/stable/)
410410

411411
**Compute box-least-squares periodogram**
412412

@@ -419,7 +419,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
419419

420420
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/Cosmology.jl)
421421

422-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/Cosmology.jl/stable/)
422+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/Cosmology/stable/)
423423

424424
**Distances in the universe**
425425

@@ -432,7 +432,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
432432

433433
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/DustExtinction.jl)
434434

435-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/DustExtinction.jl/stable/)
435+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/DustExtinction/stable/)
436436

437437
**Dust extinction laws and maps**
438438

@@ -445,7 +445,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
445445

446446
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/LombScargle.jl)
447447

448-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/LombScargle.jl/stable/)
448+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/LombScargle/stable/)
449449

450450
**Compute Lomb-Scargle periodogram**
451451

@@ -457,7 +457,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
457457

458458
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/Photometry.jl)
459459

460-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/Photometry.jl/stable/)
460+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/Photometry/stable/)
461461

462462
**Aperture photometry**
463463

@@ -469,7 +469,7 @@ The joy of our community is the many astronomy and astrophysics packages availab
469469

470470
[![curly braces](assets/code.png) Repository](https://github.com/JuliaAstro/Spectra.jl)
471471

472-
[![book icon](assets/book.png) Documentation](https://juliaastro.github.io/Spectra.jl/stable)
472+
[![book icon](assets/book.png) Documentation](https://juliaastro.org/Spectra/stable)
473473

474474
**Utilities for interfacing with astronomical spectra and synthetic spectra libraries**
475475

docs/src/tutorials/curve-fit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ julia> plot!(x, yfit, label="best fit")
141141
![](../assets/tutorials/curve-fit/linear-regression.svg)
142142

143143

144-
The packages [LsqFit](https://julianlsolvers.github.io/LsqFit.jl/latest/) and [GLM](https://juliastats.org/GLM.jl/v0.11/#Minimal-examples-1) (for generalized linear models) contain functions for performing and evaluating these types of linear fits.
144+
The packages [LsqFit](https://julianlsolvers.github.io/LsqFit.jl/dev/) and [GLM](https://juliastats.org/GLM.jl/v0.11/#Minimal-examples-1) (for generalized linear models) contain functions for performing and evaluating these types of linear fits.
145145

146146
## (Non-)linear curve fit
147147

docs/src/tutorials/jwst-image-scale-bar.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Let's get started!
66
## Packages
77

88
* [`Downloads`](https://docs.julialang.org/en/v1/stdlib/Downloads/): we'll use this built-in Julia standard library to download the raw image data
9-
* [`AstroImages`](http://juliaastro.org/AstroImages.jl/dev/): we'll use this package to load and display the image
10-
* [`Plots`](https://docs.juliaplots.org/latest/): we'll use this package to display coordinates along the image and add the scalebar
9+
* [`AstroImages`](http://juliaastro.org/AstroImages/stable/): we'll use this package to load and display the image
10+
* [`Plots`](https://docs.juliaplots.org/stable/): we'll use this package to display coordinates along the image and add the scalebar
1111

1212
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then: `add AstroImages Plots`.
1313
Alternatively, you can run `using Pkg; Pkg.add(["AstroImages", "Plots"])`.
@@ -37,7 +37,7 @@ fname = Downloads.download(
3737
```
3838

3939
## Loading the image
40-
We can use [`AstroImages.jl`](http://juliaastro.org/AstroImages.jl/dev/) to load the image.
40+
We can use [`AstroImages.jl`](http://juliaastro.org/AstroImages/stable/) to load the image.
4141

4242
```julia
4343
using AstroImages
@@ -57,7 +57,7 @@ size(carina)
5757
```
5858
Wow, that's over 120 megapixels!
5959

60-
AstroImages will fall back to downscaling it automatically before displaying it using [`ImageTransformations.restrict`](https://juliaimages.org/latest/function_reference/#ImageTransformations.restrict), but let's make our lives simpler and just use every 10th pixel:
60+
AstroImages will fall back to downscaling it automatically before displaying it using [`ImageTransformations.restrict`](https://juliaimages.org/stable/function_reference/#ImageTransformations.restrict), but let's make our lives simpler and just use every 10th pixel:
6161

6262
```julia
6363
carina = carina_full[begin:10:end, begin:10:end]
@@ -66,7 +66,7 @@ carina = carina_full[begin:10:end, begin:10:end]
6666

6767
Since we didn't put a semi-colon, the image was displayed. This works automatically if you use the VS Code editor, Jupyter notebooks, or Pluto Notebooks. If you're using a terminal, you can use [ElectronDisplay.jl](https://github.com/queryverse/ElectronDisplay.jl) or [ImageView.jl](https://github.com/JuliaImages/ImageView.jl) to open an interactive window.
6868

69-
[`imview`](http://juliaastro.org/AstroImages.jl/dev/api/#AstroImages.imview) is the function that was called automatically to display the image, but we can call it ourselves if we want to customize the display.
69+
[`AstroImages.imview`](@extref) is the function that was called automatically to display the image, but we can call it ourselves if we want to customize the display.
7070
We can make the image pop a little more by adjusting the display limits, or `clims`. These can be either a tuple of min and max values (i.e. `(0.0, 100.0)`) or a function to calculate them for us based on some criteria. We'll adjust the limits to remove the top and bottom 1% of all pixels:
7171

7272
```julia
@@ -92,7 +92,7 @@ RA---TAN
9292

9393
This shows that the coordinate type for the first axis is "RA---TAN".
9494

95-
Now, we'll combine AstroImages with the [Plots.jl](https://docs.juliaplots.org/latest/) library to display these coordinates.
95+
Now, we'll combine AstroImages with the [Plots.jl](https://docs.juliaplots.org/stable/) library to display these coordinates.
9696

9797

9898
```julia
@@ -114,8 +114,7 @@ implot(carina; grid=false, clims=Percent(98))
114114
![Carina nebula displayed in a plot without grid lines](../assets/tutorials/jwst-1/carina-4.svg)
115115

116116

117-
Full documentation for the `implot` function is available in the [AstroImages.jl docs](http://juliaastro.org/AstroImages.jl/dev/api/#AstroImages.implot).
118-
117+
See [`AstroImages.implot`](@extref) for full documentation.
119118

120119
## Adding a Scalebar
121120

@@ -213,6 +212,6 @@ annotate!(
213212

214213
To save the image, just run `savefig("output.png")`. `pdf`, `svg`, and other file formats are also supported.
215214

216-
To learn more about displaying images and world coordinates, see the [AstroImages.jl documentation](http://juliaastro.org/AstroImages.jl/dev/).
215+
To learn more about displaying images and world coordinates, see the [AstroImages.jl documentation](http://juliaastro.org/AstroImages/stable/).
217216

218-
For more on plotting in general, see the [Plots.jl documentation](https://docs.juliaplots.org/latest/).
217+
For more on plotting in general, see the [Plots.jl documentation](https://docs.juliaplots.org/stable/).

docs/src/tutorials/tabular-data.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ A wide range of tabular data formats are supported in Julia under a common [Tabl
1111

1212
## Packages
1313

14-
* [`FITSIO`](http://juliaastro.org/FITSIO.jl/stable/): we'll use this package to load a table stored in a FITS file
14+
* [`FITSIO`](http://juliaastro.org/FITSIO/stable/): we'll use this package to load a table stored in a FITS file
1515
* [`DataFrames`](https://dataframes.juliadata.org/stable/): we'll use this package to examine and manipulate the table
16-
* [`Plots`](https://docs.juliaplots.org/latest/): we'll use this package to visualize the contents of the table
17-
* [`AstroLib`](https://juliaastro.org/AstroLib.jl/stable/): general utility package. We'll use a helper function to compute a map projection.
16+
* [`Plots`](https://docs.juliaplots.org/stable/): we'll use this package to visualize the contents of the table
17+
* [`AstroLib`](https://juliaastro.org/AstroLib/stable/): general utility package. We'll use a helper function to compute a map projection.
1818

1919
You can install the necessary packages by running Julia, and typing `]` to enter Pkg-mode. Then: `add FITSIO DataFrames Plots AstroLib`.
2020
Alternatively, you can run `using Pkg; Pkg.add(["FITSIO", "DataFrames", "Plots", "AstroLib"])`.
@@ -29,7 +29,7 @@ If you're using [Pluto notebooks](https://github.com/fonsp/Pluto.jl), installing
2929

3030
The table in question is hosted alongside the [article](https://iopscience.iop.org/article/10.3847/1538-4365/abf93c). Go to Table 4 and click the link at the bottom to download it in FITS format. You'll need to uncompress the archive to see the `HGCA_vEDR3.fits` file.
3131

32-
FITS tables can be loaded using the [FITSIO](http://juliaastro.org/FITSIO.jl/stable/) package or the [AstroImages](http://juliaastro.org/AstroImages.jl/dev/) package which wraps it.
32+
FITS tables can be loaded using the [FITSIO](http://juliaastro.org/FITSIO/stable/) package or the [AstroImages](http://juliaastro.org/AstroImages/stable/) package which wraps it.
3333

3434

3535
## Loading the table
@@ -184,9 +184,9 @@ julia> scatter(
184184
)
185185
```
186186

187-
Let's improve this plot by using a different map projection. We can make this conversion using [AstroLib.jl](https://juliaastro.org/AstroLib.jl/stable/).
187+
Let's improve this plot by using a different map projection. We can make this conversion using [AstroLib.jl](https://juliaastro.org/AstroLib/stable/).
188188

189-
The function [`aitoff`](https://juliaastro.org/AstroLib.jl/stable/ref/#AstroLib.aitoff-Tuple{Real,%20Real}) takes longitude and latitude (or in this case, right-ascension and delcination) and returns a new position using an Aitoff projection.
189+
The function [`AstroLib.aitoff`](@extref) takes longitude and latitude (or in this case, right-ascension and delcination) and returns a new position using an Aitoff projection.
190190

191191
```julia-repl
192192
julia> using AstroLib
@@ -232,4 +232,4 @@ julia> scatter(
232232
We can save the plot using `savefig("myplot.pdf")`. `png`, `svg`, and other formats are also supported.
233233

234234

235-
For more on plotting in general, see the [Plots.jl documentation](https://docs.juliaplots.org/latest/).
235+
For more on plotting in general, see the [Plots.jl documentation](https://docs.juliaplots.org/stable/).

0 commit comments

Comments
 (0)