coderefinery / sphinx-lesson

Sphinx extension for creating CodeRefinery lessons
https://coderefinery.github.io/sphinx-lesson/
MIT License
15 stars 20 forks source link

sphinx-lesson doesn't have structured page metadata #30

Open rkdarst opened 4 years ago

rkdarst commented 4 years ago

in the jekyll theme, each page has metadata at the top that gets inserted into the HTML template, as well as the index page. This was one of my annoyances (you can't change to arbitrary themes, it can only support html)

In sphinx-lesson, we have a admonition block at the top/bottom with this kind of data in it. It can be different on the pages, and there is nothing to force it to be the same in every episode. Since this metadata is in a admonition block with a certain class, someone could make an extension that extracts them out, but that would be extra work but doesn't exist yet.

Equally, the table of contents is organized completely manually.

Are these differences acceptable for sphinx-lesson? Is this metadata used for any purpose, or is it this way just because jekyll makes it natural?