Use MultiDocumenter.jl #43
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abhro
reviewed
Apr 5, 2025
|
|
||
| deploydocs(; | ||
| repo = "github.com/JuliaAstro/JuliaAstro.github.io", | ||
| push_preview = true, | ||
| branch = "master", | ||
| devbranch = "source" | ||
| devbranch = "multidocumenter", |
There was a problem hiding this comment.
Should this be changed back to devbranch = "source" before merging?
There was a problem hiding this comment.
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!
abhro
approved these changes
Apr 5, 2025
icweaver
commented
Apr 5, 2025
|
Wow @icweaver , this is amazing! Thank you for setting this up! |
icweaver
commented
Apr 9, 2025
Comment on lines
+48
to
+241
| 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", | ||
| ), | ||
| ] | ||
| ), | ||
| ] |
There was a problem hiding this comment.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 wrongIt's working now, thanks @abhro!Unified search
Topbar links to external package docs
Future PR(s)?
docsindocs/make.jlwithpages.jl. Currently doing this manually (WIP here: Simplified MultiDocumenter.jl #44)