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

Migrate index creation from nbdev-index #1478

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Migrate index creation from nbdev-index #1478

merged 3 commits into from
Dec 2, 2024

Conversation

ncoop57
Copy link

@ncoop57 ncoop57 commented Dec 2, 2024

This PR adds the function create_index, which has been migrated from the nbdev-index repo. Additionally, a change was made to this index creation to allow for built-ins to be properly indexed from python's standard lib. However, in order to use this function Sphinx needs to be installed (pip install sphinx). It has been made an optional dependency, but has been added to the dev requirements in order for CI/CD to work. This PR is a dependency for the PR that I have in nbdev-index. So, I think the order will matter here - you'll need to merge this one first, and then nbdev-index will need to be merged.

@ncoop57 ncoop57 requested a review from jph00 December 2, 2024 16:05
@ncoop57 ncoop57 marked this pull request as ready for review December 2, 2024 16:05
@ncoop57
Copy link
Author

ncoop57 commented Dec 2, 2024

@jph00 not sure why this one CI test is running for so long. Any ideas?

@jph00
Copy link
Contributor

jph00 commented Dec 2, 2024

@jph00 not sure why this one CI test is running for so long. Any ideas?

Just manually restarted it.

@jph00
Copy link
Contributor

jph00 commented Dec 2, 2024

Weird. Seems to be stuck in the same place. I'll merge this and check locally. BTW I think the nb changes you made won't look great in the docs -- maybe you can clean up that a bit so this new functionality has clearer documentation and easier to understand tests?

@jph00 jph00 merged commit 90ef61a into main Dec 2, 2024
9 of 10 checks passed
@jph00 jph00 deleted the index branch December 2, 2024 16:13
@jph00 jph00 added the enhancement New feature or request label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants