sphinx-gitref

Keep your sphinx docs in sync with your code.

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 referenced in documentation still exists

  • Alert when the code has changed

  • Link to source code on github

  • Incorporate into tests or git hooks

Contents

Indices and tables