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

Another broken label. Keep docs nitpicked? #2235

Open
Helveg opened this issue Dec 5, 2023 · 2 comments
Open

Another broken label. Keep docs nitpicked? #2235

Helveg opened this issue Dec 5, 2023 · 2 comments
Labels

Comments

@Helveg
Copy link
Collaborator

Helveg commented Dec 5, 2023

There's a broken label https://docs.arbor-sim.org/en/stable/python/recipe.html#arbor.recipe.external_connections_on to cell_connection and I think the explanations might be outdated as well.

Since we're continually chasing broken docs, why not run a CI check with sphinx-build -nW which nitpicks, and elevates warnings to errors. That way only squeaky clean docs pass CI @brenthuisman ? I have succesfully used it for my own rather large Python project: https://github.com/dbbs-lab/bsb-core/blob/main/.github/workflows/docs.yml

@Helveg Helveg added the bug label Dec 5, 2023
@brenthuisman
Copy link
Contributor

Some broken stuff is on purpose: e.g. links to as-of-yet unwritten C++ API docs. In this case it's not resolved because the domain (C++, not Python) isn't specified (and the def is in the other domain).

@thorstenhater
Copy link
Contributor

I think I caught that during the units doc changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants