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

Add support for copying output files to website #1421

Open
idahlke-blacksky opened this issue Jun 27, 2024 · 0 comments
Open

Add support for copying output files to website #1421

idahlke-blacksky opened this issue Jun 27, 2024 · 0 comments

Comments

@idahlke-blacksky
Copy link

My notebooks are producing file outputs of various types that need to be available on the final docs page. Currently it appears that nbdev_docs copies the nbs folder to the _proc folder before processing the notebooks. The files I need aren't created until execution time, so they are missed. Concurrently the working directory for execution appears to be the project root, not the notebook location, so all file outputs would be written to the root directory without applying any workarounds. Without workarounds this creates some differences between the local notebook development environment and the nbdev_docs call (when done from the project root).

Generally I work around this by writing everything to ./outputs/... and creating a symlink between project_root/outputs and project_root/nbs/outputs. For now I've also created one to project_root/_proc/outputs. That works but the system is a bit janky. It requires nbdev_docs --symlinks so the default workflows don't work, and the _proc directory cannot be completely cleared.

It would be nice if the working directory were set to the file location by nbdev_docs and furthermore if created files were picked up and moved to _proc after execution was complete.

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

No branches or pull requests

1 participant