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
1
3
.. |.~.get_linkcode_resolve | replace :: ``get_linkcode_resolve() ``
2
4
.. _.~.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
13
15
.. |.sphinx.ext.linkcode | replace :: ``sphinx.ext.linkcode ``
14
16
.. _.sphinx.ext.linkcode : https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html#module-sphinx.ext.linkcode
15
17
.. |.sphinx.ext.viewcode | replace :: ``sphinx.ext.viewcode ``
16
18
.. _.sphinx.ext.viewcode : https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html#module-sphinx.ext.viewcode
17
19
20
+
18
21
.. Title: Sphinx Github Style
19
22
.. Description: A Sphinx extension to add GitHub source code links and syntax highlighting
20
23
.. Author: TDKorn (Adam Korn)
32
35
<div align =" center" >
33
36
34
37
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
36
39
:alt: Sphinx GitHub Style: GitHub Integration and Pygments Style for Sphinx Documentation
37
40
:width: 25%
38
41
@@ -96,15 +99,15 @@ Using |.sphinx.ext.linkcode|_, a ``View on GitHub`` link is added to the docume
96
99
97
100
98
101
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
100
103
:alt: sphinx-github-style adds a "View on GitHub" link
101
104
102
105
103
106
They link to and highlight the corresponding code block in your GitHub repository:
104
107
105
108
106
109
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
108
111
:alt: The linked corresponding highlighted source code block on GitHub
109
112
110
113
@@ -122,7 +125,7 @@ They link to and highlight the corresponding code block in your GitHub repositor
122
125
</th >
123
126
<tr ><td >
124
127
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
126
129
of the links added by |.sphinx.ext.viewcode |_
127
130
128
131
.. raw :: html
@@ -139,7 +142,7 @@ Syntax Highlighting
139
142
140
143
141
144
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
143
146
:alt: A code block highlighted by the Pygments style. It looks identical to GitHub.
144
147
145
148
@@ -171,7 +174,7 @@ Add any (or none) of the following configuration variables to your ``conf.py``
171
174
172
175
173
176
174
- |linkcode_blob |_
177
+ |. linkcode_blob |_
175
178
The blob to link to on GitHub - any of ``"head" ``, ``"last_tag" ``, or ``"{blob}" ``
176
179
177
180
**Type: ** ``str ``
@@ -184,18 +187,18 @@ Add any (or none) of the following configuration variables to your ``conf.py``
184
187
185
188
|
186
189
187
- |linkcode_url |_
190
+ |. linkcode_url |_
188
191
The link to your GitHub repository formatted as ``https://github.com/user/repo ``
189
192
190
193
**Type: ** ``str ``
191
194
192
195
**Default: ** ``f"https://github.com/{html_context['github_user']}/{html_context['github_repo']}/{html_context['github_version']}" ``
193
196
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
195
198
196
199
|
197
200
198
- |linkcode_link_text |_
201
+ |. linkcode_link_text |_
199
202
The text to use for the linkcode link
200
203
201
204
**Type: ** ``str ``
@@ -204,10 +207,11 @@ Add any (or none) of the following configuration variables to your ``conf.py``
204
207
205
208
|
206
209
207
- |linkcode_resolve |_
210
+ |. linkcode_resolve |_
208
211
A ``linkcode_resolve() `` function to use when resolving the link target with |.sphinx.ext.linkcode |_
209
212
210
213
**Type: ** ``Callable ``
211
214
212
215
**Default: ** Return value from |.~.get_linkcode_resolve |_
213
216
217
+
0 commit comments