Skip to content

Commit 0e3625e

Browse files
committed
docs: fix
1 parent 2f5926f commit 0e3625e

File tree

5 files changed

+17
-57
lines changed

5 files changed

+17
-57
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# SunPy
22

3-
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaSpacePhysics.github.io/SunPy.jl/stable/)
4-
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaSpacePhysics.github.io/SunPy.jl/dev/)
53
[![Build Status](https://github.com/JuliaSpacePhysics/SunPy.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaSpacePhysics/SunPy.jl/actions/workflows/CI.yml?query=branch%3Amain)
64
[![Coverage](https://codecov.io/gh/JuliaSpacePhysics/SunPy.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaSpacePhysics/SunPy.jl)
75
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
86

9-
A Julia wrapper around [SunPy](https://github.com/sunpy/sunpy)
7+
A Julia wrapper around [SunPy](https://github.com/sunpy/sunpy)
8+
9+
**Installation**: at the Julia REPL, run `using Pkg; Pkg.add("https://github.com/JuliaSpacePhysics/SunPy.jl")`
10+
11+
**Documentation**: [![Dev](https://img.shields.io/badge/docs-dev-blue.svg?logo=julia)](https://JuliaSpacePhysics.github.io/SunPy.jl/dev/)

docs/make.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
using SunPy
22
using Documenter
33

4-
DocMeta.setdocmeta!(SunPy, :DocTestSetup, :(using SunPy); recursive = true)
4+
DocMeta.setdocmeta!(SunPy, :DocTestSetup, :(using SunPy))
55

66
makedocs(;
77
modules = [SunPy],
@@ -14,7 +14,7 @@ makedocs(;
1414
pages = [
1515
"Home" => "index.md",
1616
"Tutorials" => [
17-
"Coordinates" => "tutorials/coordinates.md",
17+
# "Coordinates" => "tutorials/coordinates.md",
1818
],
1919
],
2020
)

docs/src/index.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
```@meta
2-
CurrentModule = SunPy
3-
```
4-
51
# SunPy
62

73
Documentation for [SunPy](https://github.com/JuliaSpacePhysics/SunPy.jl).
@@ -13,9 +9,9 @@ Documentation for [SunPy](https://github.com/JuliaSpacePhysics/SunPy.jl).
139
Modules = [SunPy]
1410
```
1511

16-
## Quickstart
12+
## Acquiring Data
1713

18-
Using the [`Fido`](https://docs.sunpy.org/en/stable/generated/api/sunpy.net.Fido.html) interface (a unified data search and retrieval tool) to obtain solar data.
14+
Obtaining solar data using the [`Fido`](https://docs.sunpy.org/en/stable/generated/api/sunpy.net.Fido.html) interface (a unified data search and retrieval tool).
1915

2016
```@example sunpy
2117
using SunPy, PythonCall
@@ -24,13 +20,10 @@ Fido
2420
Fido.search(a.Time("2012/3/4", "2012/3/6"), a.Instrument.lyra, a.Level.two)
2521
```
2622

27-
`Map` object in sunpy.
23+
## Maps
2824

29-
<!-- https://docs.sunpy.org/en/stable/tutorial/maps.html -->
25+
`Map` object in [sunpy](https://docs.sunpy.org/en/stable/tutorial/maps.html).
3026

3127
```@example sunpy
3228
pyimport("sunpy.data.sample")
33-
sunpy.data.sample.AIA_171_IMAGE
34-
my_map = sunpy.map.Map(sunpy.data.sample.AIA_171_IMAGE)
35-
# my_map.quicklook()
3629
```

docs/src/tutorials/coordinates.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

test/runtests.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,9 @@ using Aqua
77
end
88

99
include("fido.jl")
10+
11+
@testset "Maps" begin
12+
using PythonCall
13+
pyimport("sunpy.data.sample")
14+
sunpy.data.sample.AIA_171_IMAGE
15+
end

0 commit comments

Comments
 (0)