Skip to content

Commit

Permalink
fighting w Docummenter
Browse files Browse the repository at this point in the history
  • Loading branch information
eford committed Jul 11, 2024
1 parent a12420a commit 0b14478
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 11 deletions.
5 changes: 3 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ using EchelleCCFs
using Documenter

makedocs(;
modules=[EchelleCCFs],
modules=[EchelleCCFs],
authors="Eric Ford",
repo="https://github.com/RvSpectML/EchelleCCFs.jl/blob/{commit}{path}#L{line}",
sitename="EchelleCCFs.jl",
Expand All @@ -18,7 +18,8 @@ makedocs(;
"Examples" => "examples.md",
"Index" => "longlist.md"
],
checkdocs=:exports,
checkdocs=:none,
#checkdocs=:exports,
)

deploydocs(;
Expand Down
6 changes: 1 addition & 5 deletions docs/src/calc_ccf.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Pages = [ "calc_ccf.md" ]
Depth = 3
```


## Calculate CCFs

### Functions
Expand All @@ -19,17 +18,14 @@ Modules = [EchelleCCFs]
Private = false
Order = [:function]
```

### Types
```@autodocs
Modules = [EchelleCCFs]
Private = false
Order = [:type]
```

## Internals
```@docs RVFromCCF
```

```@autodocs
Modules = [EchelleCCFs]
Public = false
Expand Down
5 changes: 2 additions & 3 deletions docs/src/calc_rv.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ CurrentModule = EchelleCCFs

# Calculate RVs from CCF


```@contents
Pages = [ "calc_rv.md" ]
Depth = 3
Expand All @@ -23,9 +22,9 @@ Modules = [EchelleCCFs.RVFromCCF]
Private = false
Order = [:type]
```
## Internals

```@autodocs
Modules = [EchelleCCFs.RVFromCCF]
Public = false
Order = [:function, :types]
Order = [:function ]
```
5 changes: 5 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Pages = [ "index.md", "calc_ccf.md", "calc_rv.md" ]
Depth = 3
```

```@autodocs
Modules = [EchelleCCFs]
Private = false
Order = [:module]
```

## Related Documentation
- [RvSpectMLBase](https://rvspectml.github.io/RvSpectMLBase.jl/stable/)
Expand Down
2 changes: 1 addition & 1 deletion src/calc_rv/calc_rv.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Based on code by Alex Wise ([email protected])
Refactored and optimized by Eric Ford
"""

# """ Module for estimating the radial velocity based on the CCF """
""" Module for estimating the radial velocity based on the CCF """
module RVFromCCF

import Statistics: mean
Expand Down

0 comments on commit 0b14478

Please sign in to comment.