File tree Expand file tree Collapse file tree 5 files changed +12
-15
lines changed Expand file tree Collapse file tree 5 files changed +12
-15
lines changed Original file line number Diff line number Diff line change @@ -315,15 +315,15 @@ you may add your own CSS file to the Sphinx build.
315315
316316 To include only in specific documents, see the ``html-page-context `` event
317317and the :meth: `Sphinx.add_css_file ` function.
318- For example, you can add similar dotted lines as this documentation
318+ For example, you can add similar underlines as this documentation
319319and change the hover colour:
320320
321321.. code :: css
322322
323323 /* static/custom.css */
324324 .sphinx-codeautolink-a {
325- border-bottom-color : #aaa ;
326- border-bottom-style : dotted ;
325+ border-bottom-color : #ccc ;
326+ border-bottom-style : solid ;
327327 border-bottom-width : 1px ;
328328 }
329329 .sphinx-codeautolink-a :hover {
Original file line number Diff line number Diff line change @@ -5,7 +5,7 @@ sphinx-codeautolink
55sphinx-codeautolink makes code examples clickable by inserting links
66from individual code elements to the corresponding reference documentation.
77We aim for a minimal setup assuming your examples are already valid Python.
8- Click any names in the example below for a demonstration:
8+ Click any undelined name in the example below for a demonstration:
99
1010.. code :: python
1111
@@ -42,7 +42,6 @@ sphinx-codeautolink can be installed from the following sources:
4242.. code :: sh
4343
4444 $ pip install sphinx-codeautolink
45- # or, alternatively:
4645 $ conda install -c conda-forge sphinx-codeautolink
4746
4847 To enable sphinx-codeautolink, modify the extension list in ``conf.py ``.
Original file line number Diff line number Diff line change 11.sphinx-codeautolink-a {
2- border-bottom-color : # aaa ;
3- border-bottom-style : dotted ;
2+ border-bottom-color : # ccc ;
3+ border-bottom-style : solid ;
44 border-bottom-width : 1px ;
55}
Original file line number Diff line number Diff line change @@ -24,7 +24,6 @@ sphinx-codeautolink can be installed from the following sources:
2424.. code :: sh
2525
2626 $ pip install sphinx-codeautolink
27- # or, alternatively:
2827 $ conda install -c conda-forge sphinx-codeautolink
2928
3029 To enable sphinx-codeautolink, modify the extension list in ``conf.py ``.
@@ -38,9 +37,9 @@ Note that the extension name uses an underscore rather than a hyphen.
3837 ]
3938
4039 That's it! Now your code examples are linked.
41- For ways of concatenating multiple examples
42- and setting default import statements among other things,
43- have a look at the online documentation.
40+ For ways of concatenating examples, setting default import statements,
41+ or customising link style among other things,
42+ see the ` online documentation < https://sphinx-codeautolink.rtfd.org >`_ .
4443
4544.. |pypi | image :: https://img.shields.io/pypi/v/sphinx-codeautolink.svg
4645 :target: https://pypi.org/project/sphinx-codeautolink
Original file line number Diff line number Diff line change @@ -16,7 +16,6 @@ sphinx-codeautolink can be installed from the following sources:
1616.. code :: sh
1717
1818 $ pip install sphinx-codeautolink
19- # or, alternatively:
2019 $ conda install -c conda-forge sphinx-codeautolink
2120
2221 Note that the library is in early development, so version pinning is advised.
@@ -31,9 +30,9 @@ Note that the extension name uses an underscore rather than a hyphen.
3130 ]
3231
3332 That's it! Now your code examples are linked.
34- For ways of concatenating multiple examples
35- and setting default import statements among other things,
36- have a look at the online documentation.
33+ For ways of concatenating examples, setting default import statements,
34+ or customising link style among other things,
35+ see the ` online documentation < https://sphinx-codeautolink.rtfd.org >`_ .
3736
3837.. |pyversions | image :: https://img.shields.io/pypi/pyversions/sphinx-codeautolink
3938 :alt: Python versions
You can’t perform that action at this time.
0 commit comments