QuantEcon / sphinxcontrib-jupyter

A Sphinx Extension for Generating Jupyter Notebooks
BSD 3-Clause "New" or "Revised" License
74 stars 23 forks source link

[FEAT]: Improve ability to have multiple TOC #304

Open mmcky opened 4 years ago

mmcky commented 4 years ago

The current lecture site: python.quantecon.org implements multi-tocs for various streams such as graduate and undergraduate. It would be nice to develop a better way to specify this information rather than index proliferation as this is hard to edit and maintain.

Ideas:

  1. Use metadata to build various supporting index files such as introducing a toc directive for build the necessary objects and the author would label each file in a category
  2. Build a more advanced web object (i.e. network of lectures diagram) that has a configuration file

@DrDrij would you have any idea how we could build a nicer object for presenting toc for various dimensions. One idea would be a network diagram with clickable nodes showing the flow of various streams.

mmcky commented 4 years ago

I think the steps would be:

jstac commented 4 years ago

Or break the project up into two projects :-)

mmcky commented 4 years ago

thanks @jstac forgot to add that option.

DrDrij commented 4 years ago

Interesting. Comparing the toc I see there are a handful of lectures specific to each branch.

You've mentioned D3 before @mmcky I think. Here is a gallery of examples: https://github.com/d3/d3/wiki/Gallery Anything appealing?

Assuming the smiley @jstac as a hint of sarcasm? :)

jstac commented 4 years ago

Just a hint :-)

I might discuss this with Tom though. It is a bit of a monster and breaking up the lectures would reduce compile time. The cost would be more difficult cross refs.