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

Avoid circular dependencies for docs build #370

Open
sethaxen opened this issue Nov 11, 2024 · 0 comments
Open

Avoid circular dependencies for docs build #370

sethaxen opened this issue Nov 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sethaxen
Copy link
Member

Currently our docs build depends on ArviZPythonPlots, which itself depends on ArviZ. As a result, when we make a breaking change here or bump the compat of a dependency that ArviZPythonPlots also depends on, we can't build the docs in CI or test APP with that dependency in CI. Instead, we need to update both compats locally andrun the tests locally. This is not ideal for development.

Our docs build only depends on ArviZPythonPlots for tutorials. Perhaps we should a similar approach as turinglang.org. Since Turing is a metapackage, they only include package docs for the component packages. The docs for the tutorials are hosted at https://github.com/TuringLang/docs and built to https://turinglang.org/docs, while the main docs are hosted at https://github.com/TuringLang/turinglang.github.io and built to https://turinglang.org/

@sethaxen sethaxen added the documentation Improvements or additions to documentation label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant