Is it possible to specifiy a .ipynb file in the project yaml (instead of .qmd)?

[Sciemon]

Description

The shortened _quarto.yml file for a website looks like this, but the last .ipynb file is not rendered (only the .qmd files are):

website:
  [...]
  sidebar:
    - title: "Tutorials"
      style: "docked"
      contents:
        - docs/tutorials/inertia-fundamentals.qmd
        - docs/tutorials/coherency-identification.qmd
        - docs/tutorials/inertia_estimation_event_based.ipynb 
  [...]

So i wonder if only .qmd files are allowed?

[mcanouil]

Yes and it works.

1. quarto create project website
2. quarto convert about.qmd
3. rm about.qmd
4. Edit _quarto.yml

project:
  type: website

website:
  title: "demo"
  navbar:
    left:
      - href: index.qmd
        text: Home
      - sidebar:default
  sidebar:
    - id: default
      contents:
        - about.ipynb

format:
  html:
    theme: cosmo
    css: styles.css
    toc: true

❯ quarto render
[1/2] index.qmd
[2/2] about.ipynb

Output created: _site/index.html

[Sciemon]

Thank you for the reply! I will investigate what goes wrong in my example.

[Sciemon]

I found the reason for the unexpected behaviour in my example. Quarto does not render the .ipynb if there is a .qmd file with the same path present.

In the description above, this means that there are the files "docs/tutorials/inertia_estimation_event_based.ipynb" and "docs/tutorials/inertia_estimation_event_based.qmd". Quarto seems to ignore the .ipynb even if it is specified in the _quarto.yml. Instead it renders the .qmd file (not specified in the _quarto.yml).

[mcanouil]

Yes, because the default input is qmd.
In general, and for now, it's recommended to not have both qmd and ipynb for a given file path.

In the future, please share a Git repository with a small reproducible example, this would help.

[Sciemon]

I will follow your advise on creating a repository.

Regarding the recommendation of not having .qmd and .ipynb in parallel, note that there is a recommendation to do this using jupytext in the docs to maintain synchronized versions (at least it is my understanding of the jupytext docs that the file names need to be the same, and I think for most people they are).

It is also not entirely clear to me why the default file type (.qmd) is used, when a file type (.ipynb) is specified in the yaml, but I will know for the future.

[cscheid]

@Sciemon Thanks for the context.

It is also not entirely clear to me why the default file type (.qmd) is used, when a file type (.ipynb) is specified in the yaml, but I will know for the future.

To be clear, this is a Quarto bug! We have a plan for addressing the underlying issues in 2025, but it's not an immediately simple thing to do.

Regarding the recommendation of not having .qmd and .ipynb in parallel, note that there is a recommendation to do this using jupytext in the docs to maintain synchronized versions (at least it is my understanding of the jupytext docs that the file names need to be the same, and I think for most people they are).

Thanks, this is definitely a problem in our docs. At the very least, we should clarify that these should have separate base names.

[Sciemon]

Many thanks for the clarification :)