alan-turing-institute / rds-course

Materials for Turing's Research Data Science course
https://alan-turing-institute.github.io/rds-course/
31 stars 13 forks source link

Building gives some warnings. #124

Closed AoifeHughes closed 2 years ago

AoifeHughes commented 2 years ago

Running the build as

jupyter-book build coursebook

Gives a few warnings. This just needs added to yml file, I think?

checking consistency... 
rds-course/coursebook/README.md: WARNING: document isn't included in any toctree
rds-course/coursebook/modules/m2/data/README.md: WARNING: document isn't included in any toctree
rds-course/coursebook/modules/m4/summary.md: WARNING: document isn't included in any toctree
AoifeHughes commented 2 years ago

Hmm, I've just noticed that on clean builds this spits out a lot more warnings. I'm not well versed enough in jupyterbook to know if this could become a huge issue or if a line needs added to the config to deal with it or?

Users/ahughes/git/rds-course/coursebook/index.md:9: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/ahughes/git/rds-course/coursebook/index.md:21: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/ahughes/git/rds-course/coursebook/index.md:33: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/ahughes/git/rds-course/coursebook/index.md:81: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/ahughes/git/rds-course/coursebook/index.md:88: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/1.4-CollaborationAndReproducibility.ipynb:10002: WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/1.4-CollaborationAndReproducibility.ipynb:30002: WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/1.4-CollaborationAndReproducibility.ipynb:40002: WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/1.4-CollaborationAndReproducibility.ipynb:50002: WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/1.4-CollaborationAndReproducibility.ipynb:60002: WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/1.4-CollaborationAndReproducibility.ipynb:70003: WARNING: Non-consecutive header level increase; 0 to 2 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/hands-on.ipynb:20014: WARNING: Non-consecutive header level increase; 2 to 4 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/hands-on.ipynb:20020: WARNING: Non-consecutive header level increase; 2 to 4 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/hands-on.ipynb:20049: WARNING: Non-consecutive header level increase; 2 to 4 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/hands-on.ipynb:30004: WARNING: Non-consecutive header level increase; 2 to 4 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m1/hands-on.ipynb:30010: WARNING: Non-consecutive header level increase; 2 to 4 [myst.header]
/Users/ahughes/git/rds-course/coursebook/modules/m3/3.2-RulesOfTheGame.ipynb:5: ERROR: The "margin" directive may not be used within a sidebar element.
/Users/ahughes/git/rds-course/coursebook/modules/m4/4.2_Fitting_Models.ipynb:10016: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/ahughes/git/rds-course/coursebook/README.md: WARNING: document isn't included in any toctree
/Users/ahughes/git/rds-course/coursebook/modules/m2/data/README.md: WARNING: document isn't included in any toctree
/Users/ahughes/git/rds-course/coursebook/modules/m4/summary.ipynb: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] modules/m4/summary
/Users/ahughes/git/rds-course/coursebook/modules/m3/3.2-RulesOfTheGame.ipynb:340010: WARNING: 'myst' reference target not found: 3.3-histograms
generating indices... genindex done
writing additional pages... search done
copying images... [100%] _build/jupyter_execute/modules/m4/4.4_Evaluating_a_model_71_0.png
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 22 warnings.
AoifeHughes commented 2 years ago

Fixed by pull request https://github.com/alan-turing-institute/rds-course/pull/128