Skip to content

Remove hosted copies of documentation #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 1 addition & 13 deletions .github/workflows/ci.yml → .github/workflows/CI.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: build
name: Test JuliaAstro packages

on:
push:
Expand All @@ -7,18 +7,6 @@ on:
schedule:
- cron: '15 2 * * *' # 2:15 AM UTC every day
jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: "1"
- uses: julia-actions/cache@v2
- uses: julia-actions/julia-docdeploy@v1
env:
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
runs-on: ${{ matrix.os }}
Expand Down
14 changes: 10 additions & 4 deletions .github/workflows/CompatHelper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Pkg.add("CompatHelper")
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
- name: CompatHelper.main()
run: julia -e 'using CompatHelper; CompatHelper.main()'
- name: Install CompatHelper
shell: julia --color=yes {0}
run: |
using Pkg
Pkg.add("CompatHelper")
- name: Run CompatHelper
shell: julia --color=yes {0}
run: |
using CompatHelper
CompatHelper.main()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21 changes: 21 additions & 0 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Build
on:
push:
branches: [source]
pull_request:
schedule:
- cron: '15 2 * * *' # 2:15 AM UTC every day
jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: "1"
- uses: julia-actions/cache@v2
- uses: julia-actions/julia-docdeploy@v1
env:
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10 changes: 1 addition & 9 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,7 @@ using LibGit2, Pkg, TOML, UUIDs
# by generating nested documentation for packages under the JuliaAstro organization.
# That way, docs for all packages are browesable and searchable in one place!

include("install.jl")

for depe in to_use
eval(quote
using $depe
push!(allmods, $depe)
end)
end
include("pages.jl")

# We wait to import Documenter in case one of the packages requires
# an older version. If that was the case, it's version may have changed
Expand All @@ -31,7 +24,6 @@ mathengine = MathJax3(Dict(
makedocs(
sitename="JuliaAstro",
authors = "Julia Astro Contributors",
modules=identity.(allmods),
clean=true,
doctest=false,
format=Documenter.HTML(
Expand Down
122 changes: 8 additions & 114 deletions docs/pages.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Plain documenter pages
fullpages = Any[
"Home"=>"index.md"
"Home"=>"index.md",
# "Ecosystem" => "ecosystem.md";
"Tutorials" => [
"tutorials/index.md",
Expand All @@ -11,118 +11,12 @@ fullpages = Any[
"tutorials/tabular-data.md",
"tutorials/curve-fit.md",
]
]
]

# Categories to pull in from external docs
# Ordering Matters!
docsmodules = [
"Time, Coordinates, & Units" => [
"AstroLib",
"UnitfulAstro",
"AstroAngles",
"AstroTime",
"SkyCoords",
"WCS",
],
"Images" => [
"AstroImages",
"SAOImageDS9",
"Photometry",
"PSFModels",
#"CCDReduction",
"LACosmic",
"SkyImages",
],
"Data I/O" => [
"FITSIO",
"CFITSIO",
"CasaCore",
"OIFITS",
"VLBIData",
"Difmap",
"VOTables",
"VirtualObservatory",
],
"Cosmology" => [
"Cosmology"
],
"Orbits & Emphemerides" => [
# "JPLEphemeris",
"EarthOrientation",
"Transits",
"PlanetOrbits",
"AstroLib",
],
"Numerical Utilities" => [
"BoxLeastSquares",
"LombScargle"
],
"Statistics" => [
"PairPlots"
]
"Time, Coordinates, & Units" => "highlevels/timecoords.md",
"Images" => "highlevels/images.md",
"Data I/O" => "highlevels/dataio.md",
"Cosmology" => "highlevels/cosmology.md",
"Orbits & Emphemerides" => "highlevels/orb-ephem.md",
"Numerical Utilities" => "highlevels/numerical-utils.md",
"Statistics" => "highlevels/stats.md",
]


# Intro pages to a given category.
# Ensure order matches the above.
catpagestarts = [
Any["highlevels/timecoords.md"],
Any["highlevels/images.md"],
Any["highlevels/dataio.md"],
Any["highlevels/cosmology.md"],
Any["highlevels/orb-ephem.md"],
Any["highlevels/numerical-utils.md"],
Any["highlevels/stats.md"],
]

# 3rd party packages: pull in README only
usereadme = Dict(

# These are breaking the build for some reason
"PSFModels" => "https://github.com/JuliaAstro/PSFModels.jl",
# "LACosmic" => "https://github.com/JuliaAstro/LACosmic.jl",
"Transits" => "https://github.com/JuliaAstro/Transits.jl",

# No docs page yet
"AstroAngles" => "https://github.com/JuliaAstro/AstroAngles.jl",

# Ecosystem
"CasaCore" => "https://github.com/mweastwood/CasaCore.jl",
"Difmap" => "https://github.com/JuliaAPlavin/Difmap.jl",
"OIFITS" => "https://github.com/emmt/OIFITS.jl",
"PairPlots" => "https://github.com/sefffal/PairPlots.jl",
"PlanetOrbits" => "https://github.com/sefffal/PlanetOrbits.jl",
"SkyImages" => "https://github.com/JuliaAPlavin/SkyImages.jl",
"VLBIData" => "https://github.com/JuliaAPlavin/VLBIData.jl",
"VOTables" => "https://github.com/JuliaAPlavin/VOTables.jl",
"VirtualObservatory" => "https://github.com/JuliaAPlavin/VirtualObservatory.jl",
)

# Specify revision to install and build docs for.
# Every package must be listed here UNLESS it's listed in `usereadme` above.
pkgrevs = Dict(
"AstroAngles" => "main",
"AstroImages" => "master",
"AstroLib" => "master",
"AstroLib" => "master",
"AstroTime" => "main",
"BoxLeastSquares" => "main",
# "CCDReduction" => "main",
"CFITSIO" => "master",
"Cosmology" => "master",
"DustExtinction" => "master",
"EarthOrientation" => "master",
"ERFA" => "main",
"FITSIO" => "master",
"LACosmic" => "main",
#"JPLEphemeris" => "master",
"LombScargle" => "master",
"Photometry" => "main",
# "PSFModels" => "main",
"SAOImageDS9" => "master",
"SkyCoords" => "master",
# "Transits" => "main",
"UnitfulAstro" => "master",
"WCS" => "master",
)
2 changes: 2 additions & 0 deletions docs/src/ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,8 @@ The joy of our community is the many astronomy and astrophysics packages availab

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

[![book icon](assets/book.png) Documentation](https://juliaastro.org/AstroAngles.jl/dev/)

**String parsing and representation of angles**

- Parse and represent sexagesimal angles with a variety of delimiters
Expand Down
2 changes: 2 additions & 0 deletions docs/src/highlevels/timecoords.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

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

[![book icon](../assets/book.png) Documentation](https://juliaastro.org/AstroAngles.jl/dev/)

**String parsing and representation of angles**

- Parse and represent sexagesimal angles with a variety of delimiters
Expand Down
Loading