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

make docs more maintainable by correctly automating sidebar and contents order #565

Open
zsunberg opened this issue Jan 11, 2025 · 1 comment

Comments

@zsunberg
Copy link
Member

can be achieved in make.jl like this:

page_order = [
    "index.md",
    "bootstrap.md",
    "beliefs.md",
    "basic.md",
    "depletion.md",
    "sampling.md",
]

makedocs(
    modules=[ParticleFilters, POMDPs],
    format=Documenter.HTML(),
    sitename="ParticleFilters.jl",
    warnonly = [:missing_docs, :cross_references],
    pages = page_order
)

and with the appropriate line in the @contents in index.md

@dylan-asmar
Copy link
Member

I'm happy to work on this issue, but I'm not quite following the problem/proposed solution.

The pages are currently listed in the makedocs command in make.jl And @contents is used for the different sections in index.md.

Are you proposing we do something different?

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

2 participants