Skip to content

Pin Jupyter Book version#636

Merged
rafmudaf merged 2 commits intoNatLabRockies:developfrom
rafmudaf:develop
Apr 25, 2023
Merged

Pin Jupyter Book version#636
rafmudaf merged 2 commits intoNatLabRockies:developfrom
rafmudaf:develop

Conversation

@rafmudaf
Copy link
Collaborator

Resolve a dependency version bug

This pull request pins the version of the Jupyter Book dependency used in the online documentation to v0.13.3 or less. Higher versions of Jupyter Book have a conflict with the methods we use to recursively create API documentation as described in #635.

See the live and passing version of the docs build step happening here. Before this commit, the build step failed with this error as seen here.

Related issue

Work around for #635 but does not close it

Impacted areas of the software

Documentation build system

Later versions have a conflict with the _templates that we currently use to enable recursive autodocs. See these issues:
- executablebooks/sphinx-book-theme#719
- sphinx-doc/sphinx#11315
@rafmudaf rafmudaf added bug Something isn't working documentation labels Apr 25, 2023
@rafmudaf rafmudaf self-assigned this Apr 25, 2023
@rafmudaf rafmudaf merged commit 03deffe into NatLabRockies:develop Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments