[Docs] Prevented docs/1 file from being generated.

[Lunderberg]

Typo in tests/scripts/task_sphinx_precheck.sh caused $TVM_HOME/docs/1
file to be created with stderr output, rather than merged stderr and
stdout.

[tqchen]

looks like the correction reveals the doc build errors :) @Lunderberg can you attempt to fix these?

[Lunderberg]

Sure, I can take a look at the issues.

[tqchen]

ping @Lunderberg to followup on this

[Lunderberg]

Thanks for the reminder on it! I've fixed about half of the ~80 warnings this afternoon, working my way through the rest.

[Lunderberg]

The documentation build now passes without warning when I run it locally, so let's see how it goes on the CI. The most frequent issues were broken links/references, missing line breaks in docstrings before code examples, and ambiguous type references in docstrings.

[Lunderberg]

One last minor update, removed some debug code in task_sphinx_precheck.sh, but kept a deliberate repeat of the warnings at the end of the precheck script.

[Lunderberg]

Next round of updates, tested locally against the newer version of sphinx used by CI, and rebased against main. Should have all build warnings fixed up through commit 1f2ca06 on main.

[Lunderberg]

@areusch I think I'll need some help on this one, as the remaining warnings relate to the CI image and setup.

• WARNING:root:git describe: fatal: No names found, cannot describe anything.

  Cannot reproduce in the local docker image. It looks like sphinx is trying to run git describe, but the CI's copy of the repo is too shallow. How deep of a clone does the CI use?

• WARNING:root:scikit-learn version 0.24.2 is not supported. Minimum required version: 0.17. Maximum required version: 0.19.2. Disabling scikit-learn conversion API.

  From importing coremltools. The current version 4.1 has a maximum version of scikit-learn<=0.19.2. Unfortunately, the current version of gluoncv==0.10.1 has a minimum version of scikit-learn>=0.23.2, so it won't be a simple update of a single package.

[tqchen]

@Lunderberg we can try to ignore these two warnings by updating the lines here https://github.com/apache/tvm/blob/main/tests/scripts/task_sphinx_precheck.sh#L41

[Lunderberg]

Good point, and I agree that these probably aren't warnings that are relevant for the documentation building.

[Lunderberg]

And updated again, both to fix a few more issues that arose on main, and to ignore the warnings coming from git describe and coremltools.

[Lunderberg]

And it passed! Should be ready to merge, as it has up-to-date fixes for all documentation warnings on the main branch through yesterday afternoon.

[tqchen]

Thanks @Lunderberg !

[areusch]

wow, thanks @Lunderberg for catching this and fixing all the docs bugs!