py5coding / py5book

juypter book repo for py5
https://py5coding.org/
64 stars 10 forks source link

Documents not included in table of contents #55

Closed hx2A closed 1 year ago

hx2A commented 1 year ago

These warnings indicate that there is content that is not reachable from the table of contents:

/home/jim/Projects/ITP/pythonprocessing/py5book/developer/zellemarcovicci_GSOC_2022.ipynb: WARNING: document isn't included in
 any toctree                                                                                                                  
/home/jim/Projects/ITP/pythonprocessing/py5book/tutorials/installing_and_using_py5.md: WARNING: document isn't included in any
 toctree

The second one is a blank page and should probably be deleted.

The first page is important and should be included somewhere. I don't think it belongs in the developer section, but how about in tutorials? Why not have it appear at the end of the Intro to py5 and Python section? If you move it to the tutorials folder and rename it to something like intro_to_py5_and_python_gsoc.md, I think it would work better.

Speaking of ordering, the tutorials are listed in the table of contents (on the left side of the rendered website) in alphabetical order. Is this what you want? If not, you can either rename the files to include a number that will result in the correct sorting (ie intro_to_python_and_py501..., intro_to_python_and_py5_02..., intro_to_python_and_py5_03..., etc) or change the table of contents to explicitly list the order. Right now the _toc.yml file has:

  chapters:
  - file: tutorials/intro_to_py5_and_python
    sections:
    - glob: tutorials/intro_to_py5_and_python_*

That glob wildcard will alphabetize the results. Instead of using glob you can explicitly list out the files one by one.

hx2A commented 1 year ago

Thank you!