Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 2.82 KB

TODO.md

File metadata and controls

63 lines (49 loc) · 2.82 KB

Choses à faire (TODO list)

First week

  • write first version of requirements.txt, and Makefile
  • install Jupyter-book and extensions in virtualenv
  • write complete versions of requirements.txt, and Makefile
  • start fresh jupyter-book with command 
    jupyter-book create --cookiecutter
  • build the site, in HTML singlepage (not dirhtml)
  • try each builder:
    • make dirhtml: okay, but I don't see the point so won't use
    • make pdfhtml DONE: it works, but it's not so pretty. It can be useful but not great, without cheating with this config
    • make latex ? TODO: check that new pages don't break the latex output
    • make pdflatex ? TODO: check that new pages don't break the latex output
    • make linkcheck ? très utile !
  • write demo pages
  • for each extensions
    • install it, try it, add it to requirements.txt
    • write an example on the demo page
  • NOPE License Creative Commons instead of MIT ? ==> nope, flemme
  • Take inspirations from this book in French
  • create my own logo.png ? TODO later, for specific books
  • for notebooks, never include Table of Contents cell from jupyter extension: it displays wrongly in the built book
  • for notebooks, how come links are not linked by default? (https://perso.crans.org/besson/Info-Prepas-MP2I/Modele-de-livre-avec-Jupyter-Book/notebooks/Exemple%20de%20notebook%20avec%20Python.html#pour-en-apprendre-plus)

How to cleanly add TODO? - FAILED

Using a reST directive? No it doesn't work:

% .. todo:: This does not exist.

Using a reST directive and a eval-rst directive from Markdown (MyST):

% {eval-rst} % .. todo:: This does work, right? %

Using a MyST directive directly? No it broke the pdfhtml builder.

% {todo} % The {todo} MyST directive does not exist %

And printing the list of TODO:

% {eval-rst} % .. todolist:: %

See https://www.sphinx-doc.org/en/master/usage/extensions/todo.html

Demo pages

These pages should render perfectly, otherwise something is broken in the jupyter-book setup.