Add description of indexing a lesson using the index directive/role

coderefinery / sphinx-lesson

Sphinx extension for creating CodeRefinery lessons

https://coderefinery.github.io/sphinx-lesson/

MIT License

14 stars 20 forks source link

Closed rkdarst closed 2 years ago

rkdarst commented 2 years ago

Indexing allows a structured view into the context. This can be useful as a part of a quick reference guide (though the index just has the terms, not the definitions).
I'm not sure if many lessons would use this, but it is a nice feature that we may as well document. Plus, I did already, but havn't PRed it, so I may as well do it.
Review: does the text make general sense? I have a feeling there may be some things slightly wrong with it, but I will iterate that later.

bast commented 2 years ago

"WARNING: invalid pair index entry 'index, ReST'"