Skip to content

More mkdocs options #45

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.

Sign up for GitHub

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

Open
damskii9992 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

More mkdocs options #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49286c2
Backmerge: master (v0.12.0) into develop [skip ci]
Jun 4, 2026
26dc494
More mkdocs options
damskii9992 Jun 11, 2026
5c9fdf9
add easyscience to inventory
damskii9992 Jun 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions template/docs/mkdocs.yml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,13 @@ plugins:
docstring_options:
ignore_init_summary: true
summary: true
relative_crossrefs: true
scoped_crossrefs: true
filters: ["!^_[^_]", "!__repr__", "!__dir__"] # This is the default filter minus __repr__ and __dir__
inventories:
- url: https://scipp.github.io/objects.inv
- url: https://numpy.org/doc/stable/objects.inv
- url: https://easyscience.github.io/core/2.3.1/objects.inv

@AndrewSazonov AndrewSazonov Jun 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we avoid pinning the core inventory to 2.3.1 here? Since NumPy uses stable and Scipp exposes an unversioned inventory, the core URL should ideally be something like https://easyscience.github.io/core/latest/objects.inv once core publishes that alias.

It may also be worth adding a pixi.toml docs task in core to build and verify objects.inv.

@damskii9992 damskii9992 Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can solve this issue by changing the alias-type of mike. You've currently set it to "redirect" in the pixi.toml command, using "symlink" or "copy" should make it work (i think). According to Claude, symlinks aren't treated well by github pages though, so maybe we need to use "copy" for this to work . . .

- search

# Determines additional directories to watch when running mkdocs serve
Expand Down