Code Listing

[lu-kas]

Dear all,

first, thanks to the developers for this great tool!

I would like to include the listing of a file (e.g. a source code file) into the jupyter notebook. Like the listing environment in LaTeX. Is this somehow possible?

NB, I know that I could copy the content of the file into the notebook, but this way I would have to make sure that it is in sync with the actual file.

Thanks!

[jstac]

@mmcky is working on this issue but I'm not sure what the status is.

[mmcky]

@lu-kas does the contents of that file need to be executable?

If not you can use the sphinx literalinclude directive to bring in the contents from a file (but this can't be used to bring in executable code just contents of files for viewing that may or may not need syntax highlighting)

```{literalinclude} <path-to-file>
```

We are working on support in jupyter-book to bring in code from a file through a :file: option to code-cell directives. It is currently in PR phase and not yet merged -- but it is coming. You can follow progress: executablebooks/MyST-NB#286

[lu-kas]

Thanks!

This is what I was looking for -- just a passive (non executed) listing of a file. I have to admit, that I should have had a closer look into the documentation. I have not extended my search scope to the tools jupyterbook builds upon.

It is even possible to select lines, add line numbers and reference to that listing. Great!

As this capability is not part of the jupyterbook documentation, I could offer to extend the docs with a short description. Do you think, this is valuable also for other users?

[choldgraf]

@lu-kas go for it!