Repository navigation
Octavo integration - #1659
Open
RensDimmendaal wants to merge 17 commits into
Open
Octavo integration#1659RensDimmendaal wants to merge 17 commits into
RensDimmendaal wants to merge 17 commits into
Conversation
Select Octavo when octavo.yml exists in the notebooks directory, retaining Quarto otherwise. - Route docs, README, and CONTRIBUTING through the selected backend - Skip Quarto config generation during prepare for Octavo projects - Support local symbol links through an injected lookup - Reject non-default Quarto file filters for Octavo builds - Fix _nbglob_docs delegation to expose nbglob parameters - Add the nbdev[octavo] extra and build examples Export and Octavo notebook tests pass. Preview and source migration remain pending.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds octavo as an optional backend for nbdev-docs. The migration instructions are added to the octavo notebook's module docstring.
The migration is probably not perfect, because quarto has many features and I dont know which features other nbdev projects all use.
To test it I recommend reading through the notebook of course, but also to test it on another nbdev project's docs. I've ran it on nbdev's own docs and basedpl's docs for example.
I know the number of changes looks very large, but it's mainly explanations and tests in the octavo notebook.