Skip to content

Commit

Permalink
docs: fix deadlinks (#1614)
Browse files Browse the repository at this point in the history
* docs: fix broken links

* chore: update docs/conf.py

Co-authored-by: Han Xiao <artex.xh@gmail.com>
  • Loading branch information
bwanglzu and hanxiao committed Jan 7, 2021
1 parent e763f17 commit ed9be88
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ feat: add remote api

#### What if I Mess Up?

We all make mistakes. GitHub has a guide on [rewriting commit messages](https://help.github.com/en/github/committing-changes-to-your-project/changing-a-commit-message) to they can adhere to our standards.
We all make mistakes. GitHub has a guide on [rewriting commit messages](https://docs.github.com/en/free-pro-team@latest/github/committing-changes-to-your-project/changing-a-commit-message) to they can adhere to our standards.

You can also install [commitlint](https://commitlint.js.org/#/) onto your own machine and check your commit message by running:

Expand Down
10 changes: 10 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,16 @@
html_last_updated_fmt = ''
nitpicky = True
nitpick_ignore = [('py:class', 'type')]
linkcheck_ignore = [
# Avoid link check on local uri
"http://0.0.0.0:*",
# Avoid errors due to GitHub rate limit
# https://github.com/sphinx-doc/sphinx/issues/7388
"https://github.com/jina-ai/jina/commit/*",
]
linkcheck_timeout = 20
linkcheck_retries = 2
linkcheck_anchors = False

def setup(app):
from sphinx.domains.python import PyField
Expand Down

0 comments on commit ed9be88

Please sign in to comment.