Skip to content

Commit a61976a

Browse files
committed
Merge pull request #191 from agjohnson/sphinx-1.3-compat
Sphinx 1.3 compat
2 parents af82c93 + c4c681b commit a61976a

File tree

8 files changed

+22
-12
lines changed

8 files changed

+22
-12
lines changed

demo_docs/source/api.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:mod:`test_py_module`
2+
=====================
3+
4+
.. automodule:: test_py_module.test
5+
:members:
6+
:private-members:
7+
:special-members:

demo_docs/source/index.rst

+1-8
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Contents:
2424
:caption: This is an incredibly long caption for a long menu
2525

2626
long
27+
api
2728

2829
Maaaaath!
2930
=========
@@ -57,14 +58,6 @@ Giant tables
5758
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
5859
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
5960

60-
API Test
61-
========
62-
63-
.. automodule:: test_py_module.test
64-
:members:
65-
:private-members:
66-
:special-members:
67-
6861
Optional parameter args
6962
-----------------------
7063

demo_docs/source/test_py_module/test.py

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ class Foo:
2626
2727
print(myclass)
2828
29+
30+
Here is a link to :py:meth:`capitalize`.
31+
Here is a link to :py:meth:`__init__`.
32+
2933
"""
3034

3135
#: Doc comment for class attribute Foo.bar.

requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
sphinx>=1.1
1+
sphinx>=1.3

sass/_theme_layout.sass

+6
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@
5252
padding: $gutter / 4 $gutter * 1.5
5353
&:hover
5454
background: darken($section-background-color, 15%)
55+
code
56+
border: none
57+
background: inherit
58+
color: inherit
59+
padding-left: 0
60+
padding-right: 0
5561
// On state for the first level
5662
li.on a, li.current > a
5763
color: $text-color

sass/_theme_rst.sass

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@
196196
.xref, a &
197197
font-weight: bold
198198
// If the literal is inside an a tag, let's color it like a link
199-
a tt
199+
a tt, a code
200200
color: $link-color
201201
dl
202202
margin-bottom: $base-line-height

sphinx_rtd_theme/static/css/theme.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sphinx_rtd_theme/static/css/theme.css.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)