Use MultiDocumenter.jl by icweaver · Pull Request #43 · JuliaAstro/JuliaAstro.github.io

icweaver · 2025-04-04T14:29:54Z

This PR tries to get MultiDocumenter in the mix next. This is inspired from this old convo

Depends on #40

It seems to be building locally alright for me (pics below), but I am lost when it comes to CI stuff. Any help is appreciated!

Demo

Preview link

https://juliaastro.org/previews/PR43/

~~Doesn't seem to be reflecting changes yet, I am positive that I must be holding it wrong~~ It's working now, thanks @abhro!

Unified search

Topbar links to external package docs

Future PR(s)?

Sync list of docs in docs/make.jl with pages.jl. Currently doing this manually (WIP here: Simplified MultiDocumenter.jl #44)
More informative unified search. Would be cool to prepend the parent package name to search result hits to give them more context

abhro · 2025-04-05T16:50:10Z

    push_preview = true,
    branch = "master",
-    devbranch = "source"
+    devbranch = "multidocumenter",


Should this be changed back to devbranch = "source" before merging?

You read my mind. Wasn't sure how that would play with PR doc previews, but totally happy to switch it back if it looks good to you!

sefffal · 2025-04-07T21:50:47Z

Wow @icweaver , this is amazing! Thank you for setting this up!

icweaver · 2025-04-09T22:42:56Z

+docs = [
+    # We also add JuliaAstro's own generated pages
+    MultiDocumenter.MultiDocRef(
+        upstream = joinpath(@__DIR__, "build"),
+        path = "docs",
+        name = "JuliaAstro",
+        fix_canonical_url = false,
+    ),
+    MultiDocumenter.DropdownNav(
+        "Time, Coordinates, & Units",
+        [
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "AstroAngles"),
+                path = "AstroAngles",
+                name = "AstroAngles",
+                giturl = "https://github.com/JuliaAstro/AstroAngles.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "AstroTime"),
+                path = "AstroTime",
+                name = "AstroTime",
+                giturl = "https://github.com/JuliaAstro/AstroTime.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "ERFA"),
+                path = "ERFA",
+                name = "ERFA",
+                giturl = "https://github.com/JuliaAstro/ERFA.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "SkyCoords"),
+                path = "SkyCoords",
+                name = "SkyCoords",
+                giturl = "https://github.com/JuliaAstro/SkyCoords.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "UnitfulAstro"),
+                path = "UnitfulAstro",
+                name = "UnitfulAstro",
+                giturl = "https://github.com/JuliaAstro/UnitfulAstro.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "WCS"),
+                path = "WCS",
+                name = "WCS",
+                giturl = "https://github.com/JuliaAstro/WCS.jl.git",
+            ),
+        ]
+    ),
+    MultiDocumenter.DropdownNav(
+        "Images",
+        [
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "AstroImages"),
+                path = "AstroImages",
+                name = "AstroImages",
+                giturl = "https://github.com/JuliaAstro/AstroImages.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "SAOImagesDS9"),
+                path = "SAOImagesDS9",
+                name = "SAOImagesDS9",
+                giturl = "https://github.com/JuliaAstro/SAOImageDS9.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "Photometry"),
+                path = "Photometry",
+                name = "Photometry",
+                giturl = "https://github.com/juliaastro/Photometry.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "PSFModels"),
+                path = "PSFModels",
+                name = "PSFModels",
+                giturl = "https://github.com/juliaastro/PSFModels.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "LACosmic"),
+                path = "LACosmic",
+                name = "LACosmic",
+                giturl = "https://github.com/juliaastro/LACosmic.jl.git",
+            ),
+        ]
+    ),
+    MultiDocumenter.DropdownNav(
+        "Data I/O",
+        [
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "AstroImages"),
+                path = "AstroImages",
+                name = "AstroImages",
+                giturl = "https://github.com/JuliaAstro/AstroImages.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "FITSIO"),
+                path = "FITSIO",
+                name = "FITSIO",
+                giturl = "https://github.com/JuliaAstro/FITSIO.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "CFITSIO"),
+                path = "CFITSIO",
+                name = "CFITSIO",
+                giturl = "https://github.com/JuliaAstro/CFITSIO.jl.git",
+            ),
+            MultiDocumenter.Link(
+                "mweastwood/CasaCore",
+                "http://mweastwood.info/CasaCore.jl/stable/",
+            ),
+            MultiDocumenter.Link(
+                "emmt/OIFITS",
+                "https://github.com/emmt/OIFITS.jl",
+            ),
+            MultiDocumenter.Link(
+                "aplavin/VLBIData",
+                "https://github.com/JuliaAPlavin/VLBIData.jl",
+            ),
+            MultiDocumenter.Link(
+                "aplavin/Difmap",
+                "https://github.com/JuliaAPlavin/Difmap.jl",
+            ),
+        ]
+    ),
+    MultiDocumenter.DropdownNav(
+        "Cosmology",
+        [
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "Cosmology"),
+                path = "Cosmology",
+                name = "Cosmology",
+                giturl = "https://github.com/JuliaAstro/Cosmology.jl.git",
+            ),
+        ]
+    ),
+    MultiDocumenter.DropdownNav(
+        "Orbits & Ephemerides",
+        [
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "Transits"),
+                path = "Transits",
+                name = "Transits",
+                giturl = "https://github.com/JuliaAstro/Transits.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "sefffal/PlanetOrbits"),
+                path = "sefffal/PlanetOrbits",
+                name = "sefffal/PlanetOrbits",
+                giturl = "https://github.com/sefffal/PlanetOrbits.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "EarthOrientation"),
+                path = "EarthOrientation",
+                name = "EarthOrientation",
+                giturl = "https://github.com/JuliaAstro/EarthOrientation.jl.git",
+            ),
+            MultiDocumenter.Link(
+                "JPLEphemeris",
+                "https://github.com/JuliaAstro/JPLEphemeris.jl",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "AstroLib"),
+                path = "AstroLib",
+                name = "AstroLib",
+                giturl = "https://github.com/JuliaAstro/AstroLib.jl.git",
+            ),
+        ]
+    ),
+    MultiDocumenter.DropdownNav(
+        "Numerical Utilities",
+        [
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "BoxLeastSquares"),
+                path = "BoxLeastSquares",
+                name = "BoxLeastSquares",
+                giturl = "https://github.com/JuliaAstro/BoxLeastSquares.jl.git",
+            ),
+            MultiDocumenter.MultiDocRef(
+                upstream = joinpath(clonedir, "LombScargle"),
+                path = "LombScargle",
+                name = "LombScargle",
+                giturl = "https://github.com/JuliaAstro/LombScargle.jl.git",
+            ),
+        ]
+    ),
+    MultiDocumenter.DropdownNav(
+        "Statistics",
+        [
+            MultiDocumenter.Link(
+                "sefffal/PairPlots",
+                "https://sefffal.github.io/PairPlots.jl/dev",
+            ),
+        ]
+    ),
+]


This bit is all manual and gross for now just to stand things up, and can be replaced by something like #44 if we end up wanting to go the "single source of truth" route discussed there

icweaver · 2025-04-10T23:23:58Z

#44 has been working better than expected, so I'm actually inclined to just have it subsume #40 and this PR at this point. What do y'all think?

abhro · 2025-04-11T13:08:25Z

#44 has been working better than expected, so I'm actually inclined to just have it subsume #40 and this PR at this point. What do y'all think?

Yes, I think that would be the final option to go with, but I'm not sure about #44 subsuming this PR. The ecosystem layout doesn't exactly much the current categorization, and at least from my perspective, the current one is easier to use. But that's a small change to make, so it's not too big of an issue.

The other part is, I'm not sure why the ecosystem page was hidden in the first place, so it's probably worth it to wait and hear from someone who oversaw the previous layout transition 👍
And also, thank you for your amazing work on this!

icweaver · 2025-04-11T14:44:08Z

Thanks, sounds good! Maybe @sefffal has some thoughts?

abhro and others added 24 commits March 30, 2025 23:05

Removing hosting of other packages' docs

eb24cc1

Add docs site link for AstroAngles.jl

7459aed

Update assets link

ef85786

Add GitHub token secret to docs CI

e1ffaca

Merge remote-tracking branch 'origin/rm-hosted-copies' into source

d03a0f4

first pass at multidocs

2c6cdd7

src different than dst

c627f09

trying deploy

4e402bd

split workflow steps

0f6b853

instantiate

c7f4072

going back to docdeploy action

777694d

no orphans

d90ac6f

try deploydocs directly

2efcffe

update branches and switch deploy method

89b6c34

back to deploydocs

b6c6915

back to manual deploy

44338f2

typo?

430b814

whitespace

39fd960

specify branch

d562e7b

cleanup

07daec8

Use shell option for workflow yml

8a9eefc

Use julia color option for docs/make.jl workflow step

fefd672

Add favicon to Documenter.HTML() assets

24f81f3

Add versions keyword to deploydocs()

7043e22

abhro self-requested a review April 5, 2025 16:46

abhro reviewed Apr 5, 2025

View reviewed changes

abhro approved these changes Apr 5, 2025

View reviewed changes

Trying updated search path

5be9729

icweaver commented Apr 5, 2025

View reviewed changes

Comment thread docs/make.jl Outdated

trying temporary PR preview root for universal search functionality

98cbe98

icweaver added 3 commits April 5, 2025 12:00

fix search path

f197c0e

enabled sitemap again

0e830bd

typo

fcd3307

abhro requested a review from mileslucas April 5, 2025 21:47

abhro marked this pull request as ready for review April 5, 2025 21:48

abhro requested a review from giordano April 5, 2025 22:41

icweaver mentioned this pull request Apr 9, 2025

Simplified MultiDocumenter.jl #44

Merged

icweaver changed the title ~~Multidocumenter experiment~~ Use MultiDocumenter.jl Apr 9, 2025

icweaver commented Apr 9, 2025

View reviewed changes

Change devbranch in deploydocs back to source

18fc0d7

abhro merged commit 158e4fe into source Apr 12, 2025

abhro deleted the multidocumenter branch April 12, 2025 13:57

This was referenced Apr 12, 2025

Remove hosted copies of documentation #40

Closed

Remove documentation pages for hosted/online projects #30

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use MultiDocumenter.jl#43

Use MultiDocumenter.jl#43
abhro merged 30 commits into
sourcefrom
multidocumenter

icweaver commented Apr 4, 2025 •

edited

Loading

Uh oh!

abhro Apr 5, 2025 •

edited

Loading

Uh oh!

icweaver Apr 5, 2025

Uh oh!

Uh oh!

sefffal commented Apr 7, 2025

Uh oh!

icweaver Apr 9, 2025

Uh oh!

icweaver commented Apr 10, 2025 •

edited

Loading

Uh oh!

abhro commented Apr 11, 2025

Uh oh!

icweaver commented Apr 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

icweaver commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Demo

Preview link

Unified search

Topbar links to external package docs

Future PR(s)?

Uh oh!

abhro Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

icweaver Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sefffal commented Apr 7, 2025

Uh oh!

icweaver Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

icweaver commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abhro commented Apr 11, 2025

Uh oh!

icweaver commented Apr 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

icweaver commented Apr 4, 2025 •

edited

Loading

abhro Apr 5, 2025 •

edited

Loading

icweaver commented Apr 10, 2025 •

edited

Loading