https://github.com/jupyter/sphinxcontrib_github_alt

Github roles for Sphinx docs
https://github.com/jupyter/sphinxcontrib_github_alt

github sphinx-doc

Last synced: 3 months ago
JSON representation

Github roles for Sphinx docs

• Host: GitHub
• URL: https://github.com/jupyter/sphinxcontrib_github_alt
• Owner: jupyter
• License: other
• Created: 2017-02-14T17:47:27.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-27T09:12:55.000Z (almost 6 years ago)
• Last Synced: 2025-01-29T21:28:04.700Z (about 1 year ago)
• Topics: github, sphinx-doc
• Language: Python
• Homepage: https://pypi.python.org/pypi/sphinxcontrib_github_alt
• Size: 8.79 KB
• Stars: 5
• Watchers: 8
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: COPYING.md

Awesome Lists containing this project

README

          
Link to GitHub issues, pull requests, commits and users for a particular project.

To use this extension, add it to the ``extensions`` list in ``conf.py``,

and set the variable ``github_project_url``:

.. code-block:: python

    extensions = [...

                  'sphinxcontrib_github_alt',

                 ]

    github_project_url = "https://github.com/ipython/ipython"

Then use these roles in your documentation:

.. code-block:: rst

    * :ghissue:`12` - link to issue #12

    * :ghpull:`35` - link to pull request #35

    * :ghcommit:`3a1cb54` - link to commit

    * :ghuser:`ipython` - link to a user or organisation

It's called 'alt' because `sphinxcontrib-github

`__ already exists. IPython

& Jupyter projects have been using the syntax defined in this extension for some

time before we made it into its own package, so we didn't want to switch to

``sphinxcontrib-github``.