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

Consider a jb-journal TOC format #31

Open
choldgraf opened this issue Apr 21, 2021 · 1 comment
Open

Consider a jb-journal TOC format #31

choldgraf opened this issue Apr 21, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Member

choldgraf commented Apr 21, 2021

I was recently in a meeting where we were talking about building an end-to-end pipeline for publishing using Jupyter notebooks + md files etc as inputs.

It made me wonder if we could define another TOC format that is designed for a collection of papers. This would essentially be a way to generalize the jb-article format to include multiple papers, so maybe it'd be as simple as:

format: jb-journal
root: index
articles:
- title: some title
  sections:
  - The rest is the same as jb-article
- title: some other
  sections:
  - The rest is the same as jb-article

What would be even more interesting is if we could trigger different doctree logic depending on the TOC format. For example, maybe if it's an article, then sections have the option of being concatenated into a single page, rather than existing as unique URLs each (basically, the same behavior as singlehtml but at the level of a toctree rather than for the whole site.

(obviously this is a future issue and not blocking on an early release)

@choldgraf choldgraf added the enhancement New feature or request label Apr 21, 2021
@chrisjsewell
Copy link
Member

What would be even more interesting is if we could trigger different doctree logic depending on the TOC format.

well this will already actually the case with jupyterbook-latex; where it will auto-infer the toplevel sectioning based on the format (executablebooks/sphinx-jupyterbook-latex#55)

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

No branches or pull requests

2 participants