Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Fix broken links. #7341

Merged
merged 3 commits into from
Oct 20, 2021
Merged

Conversation

trivialfis
Copy link
Member

  • Fix most of the link checks from sphinx.
  • Remove duplicate explicit target name.

Some page anchors created by Github markdown and Apache Spark API references are considered as broken by sphinx, so I can't run the linkcheck on CI yet. See sphinx-doc/sphinx#9016 for details.

@trivialfis trivialfis changed the title [doc] Fix broken links. [skip ci] [doc] Fix broken links. Oct 19, 2021
@trivialfis trivialfis force-pushed the doc-fix-broken-links branch from 233d041 to 50bc97e Compare October 19, 2021 06:07
@codecov-commenter
Copy link

Codecov Report

Merging #7341 (50bc97e) into master (fbb0dc4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #7341   +/-   ##
=======================================
  Coverage   83.68%   83.68%           
=======================================
  Files          13       13           
  Lines        3885     3885           
=======================================
  Hits         3251     3251           
  Misses        634      634           
Impacted Files Coverage Δ
python-package/xgboost/core.py 84.55% <ø> (ø)

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 fbb0dc4...50bc97e. Read the comment docs.

@@ -25,6 +25,6 @@ Making a Release
4. Create a tag on release branch, either on GitHub or locally.
5. Make a release on GitHub tag page, which might be done with previous step if the tag is created on GitHub.
6. Submit pip, CRAN, and Maven packages.
- The pip package is maintained by [Hyunsu Cho](http://hyunsu-cho.io/) and [Jiaming Yuan](https://github.com/trivialfis). There's a helper script for downloading pre-built wheels on ``xgboost/dev/release-pypi.py`` along with simple instructions for using ``twine``.
- The pip package is maintained by [Hyunsu Cho](https://github.com/hcho3) and [Jiaming Yuan](https://github.com/trivialfis). There's a helper script for downloading pre-built wheels on ``xgboost/dev/release-pypi.py`` along with simple instructions for using ``twine``.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The links should be reformatted using the RST syntax.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Along with some more small formating issues fixed.

* Fix most of the link checks from sphinx.
* Remove duplicate explicit target name.
@trivialfis trivialfis force-pushed the doc-fix-broken-links branch from 50bc97e to f57f751 Compare October 20, 2021 05:19
@trivialfis trivialfis merged commit 376b448 into dmlc:master Oct 20, 2021
@trivialfis trivialfis deleted the doc-fix-broken-links branch October 20, 2021 06:45
trivialfis added a commit to trivialfis/xgboost that referenced this pull request Nov 11, 2021
* Fix most of the link checks from sphinx.
* Remove duplicate explicit target name.
trivialfis added a commit that referenced this pull request Nov 11, 2021
* Fix most of the link checks from sphinx.
* Remove duplicate explicit target name.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants