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

Reading from generated files not stored in the source directory or filesystem at all #10641

Open
jbms opened this issue Jul 5, 2022 · 1 comment
Labels
extensions:autosummary type:enhancement enhance or introduce a new feature

Comments

@jbms
Copy link
Contributor

jbms commented Jul 5, 2022

Currently, extensions like autosummary write files directly to the source directory in the builder-inited step, in order to then allow them to be processed as additional documents.

In general it is inconvenient to write to the source directory:

  • Source directory might be read-only
  • Issues with multiple builds happening concurrently from the same directory
  • Users might accidentally check these generated files into source control.
  • Need care to avoid accidentally clobbering files that should not be clobbered while still being able to overwrite an existing generated file.

It would be better if extensions could generate "virtual" source documents, that are processed like any other document in the source directory but are just stored in memory and never need to be written to the filesystem.

@jbms jbms added the type:enhancement enhance or introduce a new feature label Jul 5, 2022
@tk0miya
Copy link
Member

tk0miya commented Jul 5, 2022

Absolutely. Contributions are always welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extensions:autosummary type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

3 participants