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

Using DocInventories.jl for links between GAPDoc and Documenter? #1165

Open
fingolfin opened this issue Mar 13, 2025 · 0 comments
Open

Using DocInventories.jl for links between GAPDoc and Documenter? #1165

fingolfin opened this issue Mar 13, 2025 · 0 comments
Labels

Comments

@fingolfin
Copy link
Member

Today I learned about https://github.com/JuliaDocs/DocInventories.jl and https://github.com/JuliaDocs/DocumenterInterLinks.jl

The latter allows linking between documentation of two (or more) projects using Documenter.jl or Spinx (used by many Python packages). The former is the backbone for that integration in that it reads and write "inventories" for those manuals which enables the linking.

In theory it should be possible to extend GAPDoc to also write such objects.inv files, and who knows, perhaps also read them with some effort.

That would then allow linking between Documenter and GAPDoc manuals (well, and Sphinx manuals).

This is nothing urgent but might nevertheless be interesting to pursue.

@fingolfin fingolfin added documentation kind: enhancement New feature or request labels Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant