Skip to content
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

Remove documentation pages for hosted/online projects #30

Open
abhro opened this issue May 10, 2024 · 2 comments
Open

Remove documentation pages for hosted/online projects #30

abhro opened this issue May 10, 2024 · 2 comments

Comments

@abhro
Copy link
Member

abhro commented May 10, 2024

It becomes confusing to host the full documentation copy for packages such as AstroLib.jl at https://juliaastro.org/dev/modules/AstroLib when the package already has its own documentation website at https://juliaastro.org/AstroLib.jl/stable/. This sort of nesting duplicates unnecessary information and makes the site hard to navigate. For projects that already have their own documentation websites (like FITSIO.jl and Photometry.jl, but NOT AstroAngles.jl), we can just include a link to the package's own documentation website.

@abhro
Copy link
Member Author

abhro commented Jun 17, 2024

docs/make.jl states

# This make file compiles the documentation for the JuliaAstro website.
# It consists of the usual documeter structure, but also follows the approach
# of the SciML docs page https://github.com/SciML/SciMLDocs/blob/main/docs/make.jl
# by generating nested documentation for packages under the JuliaAstro organization.
# That way, docs for all packages are browesable and searchable in one place!

but the newer version of SciML docs (https://docs.sciml.ai) only have the standalone documents on there, with a menubar linking to all the packages. Making the menubar right now might be too much work, but adding a "package index" page might also work.

@abhro
Copy link
Member Author

abhro commented Jun 17, 2024

Also, in install.jl, the variable requiredmods is looked for in a given docs/pages.jl of a package. When looking at a package on its own, it's not immediately obvious why pages.jl would hold requiredmods, unless the requirement by this project is known. (Made the mistake with AstroImages.jl)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant