dmlc / gluon-nlp

NLP made easy

https://nlp.gluon.ai/

Apache License 2.0

2.55k stars 538 forks source link

[CI] set doc options in makefile #1412

Closed szha closed 3 years ago

szha commented 3 years ago

Description

set doc options in makefile

Checklist

Essentials

[x] PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
[x] Changes are complete (i.e. I finished coding on this PR)
[x] All changes have test coverage
[x] Code is well-documented

Changes

[x] set doc options in makefile
[x] add --keep-going option for printing all warnings

codecov[bot] commented 3 years ago

Codecov Report

Merging #1412 into master will decrease coverage by 0.08%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1412      +/-   ##
==========================================
- Coverage   85.24%   85.15%   -0.09%     
==========================================
  Files          53       53              
  Lines        6954     6954              
==========================================
- Hits         5928     5922       -6     
- Misses       1026     1032       +6

Impacted Files	Coverage Δ
src/gluonnlp/data/loading.py	`81.13% <0.00%> (-2.27%)`	:arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 0484e64...b66c146. Read the comment docs.

szha commented 3 years ago

@barry-jin the doc build should now print all warnings instead of aborting on the first warning

sxjscience commented 3 years ago

Not sure why the doc is failing. Is it because the jupyter notebooks haven't been compiled?

barry-jin commented 3 years ago

@szha Thanks for pointing it out. For now, I’m working on compile_notebooks.sh, which will not exit with failure if notebooks didn’t compile successfully. You can check build artifacts to find the failed compilation. Also the missing jupyternotebooks will be reported when building the website.

szha commented 3 years ago

The warnings haven't been fixed. This change is just to expose them all at the same time instead of printing only one.

barry-jin commented 3 years ago

I see. These warnings will be fixed in PR #1418 as they are caused by notebook compilation failures.