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

API Reference page not loading #139

Closed
lukem12345 opened this issue Jun 5, 2024 · 2 comments · Fixed by #140
Closed

API Reference page not loading #139

lukem12345 opened this issue Jun 5, 2024 · 2 comments · Fixed by #140
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lukem12345
Copy link
Member

The API Reference page in these docs is not loading: https://algebraicjulia.github.io/ACSets.jl/dev/api/

Looking at the corresponding .md file, this could probably be resolved by listing out the modules manually, instead of relying on Reexport to pass those docstrings to the main ACSets module.

@jpfairbanks
Copy link
Member

That is the standard way to resolve this problem. I did it in Gatlab.jl in https://github.com/AlgebraicJulia/GATlab.jl/pull/31/files

@lukem12345
Copy link
Member Author

lukem12345 commented Jun 5, 2024

My initial pass at listing out the modules manually uncovered a couple of small errors, such as an invalid docstring Ref to IDAllocator which was merged with another type and renamed in 26c7530 and a sister commit. I’ll make a pass at updating those sorts of things as well.

@lukem12345 lukem12345 added the documentation Improvements or additions to documentation label Jun 5, 2024
@lukem12345 lukem12345 self-assigned this Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants