Skip to content

Commit 221fe5f

Browse files
committed
Bump to v1.2.1
1 parent 4a090a2 commit 221fe5f

File tree

2 files changed

+25
-21
lines changed

2 files changed

+25
-21
lines changed

README.rst

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1+
.. |.add_linkcode_class+styled with CSS| replace:: styled with CSS
2+
.. _.add_linkcode_class+styled with CSS: https://sphinx-github-style.readthedocs.io/en/latest/add_linkcode_class.html
13
.. |.~.get_linkcode_resolve| replace:: ``get_linkcode_resolve()``
24
.. _.~.get_linkcode_resolve: https://sphinx-github-style.readthedocs.io/en/latest/linkcode.html#sphinx_github_style.utils.linkcode.get_linkcode_resolve
3-
.. |linkcode_blob| replace:: ``linkcode_blob``
4-
.. _linkcode_blob: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_blob
5-
.. |linkcode_link_text| replace:: ``linkcode_link_text``
6-
.. _linkcode_link_text: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_link_text
7-
.. |linkcode_resolve| replace:: ``linkcode_resolve``
8-
.. _linkcode_resolve: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_resolve
9-
.. |linkcode_url| replace:: ``linkcode_url``
10-
.. _linkcode_url: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_url
11-
.. |sphinx+html_context| replace:: ``html_context``
12-
.. _sphinx+html_context: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_context
5+
.. |.linkcode_blob| replace:: ``linkcode_blob``
6+
.. _.linkcode_blob: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_blob
7+
.. |.linkcode_link_text| replace:: ``linkcode_link_text``
8+
.. _.linkcode_link_text: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_link_text
9+
.. |.linkcode_resolve| replace:: ``linkcode_resolve``
10+
.. _.linkcode_resolve: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_resolve
11+
.. |.linkcode_url| replace:: ``linkcode_url``
12+
.. _.linkcode_url: https://sphinx-github-style.readthedocs.io/en/latest/index.html#confval-linkcode_url
13+
.. |.sphinx+html_context| replace:: ``html_context``
14+
.. _.sphinx+html_context: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_context
1315
.. |.sphinx.ext.linkcode| replace:: ``sphinx.ext.linkcode``
1416
.. _.sphinx.ext.linkcode: https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html#module-sphinx.ext.linkcode
1517
.. |.sphinx.ext.viewcode| replace:: ``sphinx.ext.viewcode``
1618
.. _.sphinx.ext.viewcode: https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html#module-sphinx.ext.viewcode
1719

20+
1821
.. Title: Sphinx Github Style
1922
.. Description: A Sphinx extension to add GitHub source code links and syntax highlighting
2023
.. Author: TDKorn (Adam Korn)
@@ -32,7 +35,7 @@
3235
<div align="center">
3336

3437

35-
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.0/docs/source/_static/logo_square_grey_blue.png
38+
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.1/docs/source/_static/logo_square_grey_blue.png
3639
:alt: Sphinx GitHub Style: GitHub Integration and Pygments Style for Sphinx Documentation
3740
:width: 25%
3841

@@ -96,15 +99,15 @@ Using |.sphinx.ext.linkcode|_, a ``View on GitHub`` link is added to the docume
9699

97100

98101

99-
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.0/docs/source/_static/github_link.png
102+
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.1/docs/source/_static/github_link.png
100103
:alt: sphinx-github-style adds a "View on GitHub" link
101104

102105

103106
They link to and highlight the corresponding code block in your GitHub repository:
104107

105108

106109

107-
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.0/docs/source/_static/github_linked_code.png
110+
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.1/docs/source/_static/github_linked_code.png
108111
:alt: The linked corresponding highlighted source code block on GitHub
109112

110113

@@ -122,7 +125,7 @@ They link to and highlight the corresponding code block in your GitHub repositor
122125
</th>
123126
<tr><td>
124127

125-
These links can be `styled with CSS <https://sphinx-github-style.readthedocs.io/en/latest/add_linkcode_class.html>`_ and used with/instead
128+
These links can be |.add_linkcode_class+styled with CSS|_ and used with/instead
126129
of the links added by |.sphinx.ext.viewcode|_
127130

128131
.. raw:: html
@@ -139,7 +142,7 @@ Syntax Highlighting
139142

140143

141144

142-
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.0/docs/source/_static/syntax_highlighting.png
145+
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-github-style/v1.2.1/docs/source/_static/syntax_highlighting.png
143146
:alt: A code block highlighted by the Pygments style. It looks identical to GitHub.
144147

145148

@@ -171,7 +174,7 @@ Add any (or none) of the following configuration variables to your ``conf.py``
171174

172175

173176

174-
|linkcode_blob|_
177+
|.linkcode_blob|_
175178
The blob to link to on GitHub - any of ``"head"``, ``"last_tag"``, or ``"{blob}"``
176179

177180
**Type:** ``str``
@@ -184,18 +187,18 @@ Add any (or none) of the following configuration variables to your ``conf.py``
184187

185188
|
186189
187-
|linkcode_url|_
190+
|.linkcode_url|_
188191
The link to your GitHub repository formatted as ``https://github.com/user/repo``
189192

190193
**Type:** ``str``
191194

192195
**Default:** ``f"https://github.com/{html_context['github_user']}/{html_context['github_repo']}/{html_context['github_version']}"``
193196

194-
* If not provided, will attempt to create the link from the |sphinx+html_context|_ dict
197+
* If not provided, will attempt to create the link from the |.sphinx+html_context|_ dict
195198

196199
|
197200
198-
|linkcode_link_text|_
201+
|.linkcode_link_text|_
199202
The text to use for the linkcode link
200203

201204
**Type:** ``str``
@@ -204,10 +207,11 @@ Add any (or none) of the following configuration variables to your ``conf.py``
204207

205208
|
206209
207-
|linkcode_resolve|_
210+
|.linkcode_resolve|_
208211
A ``linkcode_resolve()`` function to use when resolving the link target with |.sphinx.ext.linkcode|_
209212

210213
**Type:** ``Callable``
211214

212215
**Default:** Return value from |.~.get_linkcode_resolve|_
213216

217+

sphinx_github_style/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from .utils.sphinx import get_conf_val, set_conf_val
66
from .utils.linkcode import get_linkcode_url, get_linkcode_revision, get_linkcode_resolve
77

8-
__version__ = "1.2.0"
8+
__version__ = "1.2.1"
99
__author__ = 'Adam Korn <hello@dailykitten.net>'
1010

1111
from .add_linkcode_class import add_linkcode_node_class

0 commit comments

Comments
 (0)