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 · 3 comments · May be fixed by #566
Open

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

zsunberg opened this issue Jan 11, 2025 · 3 comments · May be fixed by #566
Assignees

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?

@zsunberg
Copy link
Member Author

zsunberg commented Feb 8, 2025

I mean that if we create the page_order variable, we can re-use it in the @contents block like this:

```@contents
Pages = Main.page_order

@zsunberg
Copy link
Member Author

zsunberg commented Feb 8, 2025

It will be more DRY. (Don't Repeat Yourself)

@dylan-asmar dylan-asmar self-assigned this Feb 10, 2025
@dylan-asmar dylan-asmar linked a pull request Feb 10, 2025 that will close this issue
@dylan-asmar dylan-asmar linked a pull request Feb 10, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants