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

Update docs outline generation #566

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docs outline generation #566

wants to merge 1 commit into from

Conversation

dylan-asmar
Copy link
Member

@dylan-asmar dylan-asmar commented Feb 10, 2025

This addresses #565.

This maintains the structure as before where we have subsections for each part of then the outline. The current way @contents is structured, it only accepts a list (link to documentation) for the Pages variable. If you pass the same structure we generate for makedocs you get:

ERROR: LoadError: MethodError: Cannot convert an object of type Pair{String, Vector{String}} to an object of type String
The function convert exists, but no method is defined for this combination of argument types.

This version appends the outline to the bottom of index.md, generates the docs, and then restores the original index.md file.

With that being said...we don't have to maintain the layout as we currently have it.

@dylan-asmar
Copy link
Member Author

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

Successfully merging this pull request may close these issues.

make docs more maintainable by correctly automating sidebar and contents order
1 participant