sphinx-gitref

Link to source code and validate references in documentation

Read the documentation, install it from pypi, or grab the code from github.

Adds a :gitref:`..` role to sphinx to link to your code on GitHub, GitLab or Bitbucket, and to make sure the references in your docs match the code.

Key features:

  • Check code references are up to date
  • Link to source code on github
  • Incorporate into tests or git hooks