Skip to content

Commit 0b14478

Browse files
committed
fighting w Docummenter
1 parent a12420a commit 0b14478

File tree

5 files changed

+12
-11
lines changed

5 files changed

+12
-11
lines changed

docs/make.jl

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

44
makedocs(;
5-
modules=[EchelleCCFs],
5+
modules=[EchelleCCFs],
66
authors="Eric Ford",
77
repo="https://github.com/RvSpectML/EchelleCCFs.jl/blob/{commit}{path}#L{line}",
88
sitename="EchelleCCFs.jl",
@@ -18,7 +18,8 @@ makedocs(;
1818
"Examples" => "examples.md",
1919
"Index" => "longlist.md"
2020
],
21-
checkdocs=:exports,
21+
checkdocs=:none,
22+
#checkdocs=:exports,
2223
)
2324

2425
deploydocs(;

docs/src/calc_ccf.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Pages = [ "calc_ccf.md" ]
1010
Depth = 3
1111
```
1212

13-
1413
## Calculate CCFs
1514

1615
### Functions
@@ -19,17 +18,14 @@ Modules = [EchelleCCFs]
1918
Private = false
2019
Order = [:function]
2120
```
21+
2222
### Types
2323
```@autodocs
2424
Modules = [EchelleCCFs]
2525
Private = false
2626
Order = [:type]
2727
```
2828

29-
## Internals
30-
```@docs RVFromCCF
31-
```
32-
3329
```@autodocs
3430
Modules = [EchelleCCFs]
3531
Public = false

docs/src/calc_rv.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ CurrentModule = EchelleCCFs
44

55
# Calculate RVs from CCF
66

7-
87
```@contents
98
Pages = [ "calc_rv.md" ]
109
Depth = 3
@@ -23,9 +22,9 @@ Modules = [EchelleCCFs.RVFromCCF]
2322
Private = false
2423
Order = [:type]
2524
```
26-
## Internals
25+
2726
```@autodocs
2827
Modules = [EchelleCCFs.RVFromCCF]
2928
Public = false
30-
Order = [:function, :types]
29+
Order = [:function ]
3130
```

docs/src/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Pages = [ "index.md", "calc_ccf.md", "calc_rv.md" ]
99
Depth = 3
1010
```
1111

12+
```@autodocs
13+
Modules = [EchelleCCFs]
14+
Private = false
15+
Order = [:module]
16+
```
1217

1318
## Related Documentation
1419
- [RvSpectMLBase](https://rvspectml.github.io/RvSpectMLBase.jl/stable/)

src/calc_rv/calc_rv.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Based on code by Alex Wise (aw@psu.edu)
66
Refactored and optimized by Eric Ford
77
"""
88

9-
# """ Module for estimating the radial velocity based on the CCF """
9+
""" Module for estimating the radial velocity based on the CCF """
1010
module RVFromCCF
1111

1212
import Statistics: mean

0 commit comments

Comments
 (0)