Skip to content

Commit e7553b5

Browse files
committed
Fix bad Sphinx references
Closes #73.
1 parent 9e8b167 commit e7553b5

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

CHANGES.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,10 @@ Changes
135135
- :func:`show_refs` and :func:`show_backrefs` now accept a file-like object
136136
(via the new ``output`` argument) as an alternative to a filename.
137137

138-
- Made internal helper methods private. This includes :func:`find_chain`,
139-
:func:`show_graph`, :func:`obj_node_id`, :func:`obj_label`, :func:`quote`,
140-
:func:`long_typename`, :func:`safe_repr`, :func:`short_repr`,
141-
:func:`gradient`, :func:`edge_label`, and :func:`_program_in_path`.
138+
- Made internal helper methods private. This includes ``find_chain``,
139+
``show_graph``, ``obj_node_id``, ``obj_label``, ``quote``,
140+
``long_typename``, ``safe_repr``, ``short_repr``,
141+
``gradient``, ``edge_label``, and ``_program_in_path``.
142142

143143
- Correctly determine the name of old-style classes in :func:`count`,
144144
:func:`by_type`, and graph drawing functions.

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ FILE_WITH_CHANGELOG = CHANGES.rst
55

66
VCS_DIFF_IMAGES = git diff docs/*.png
77

8-
SPHINXOPTS = -n
8+
SPHINXOPTS = -Wn
99
SPHINXBUILD = sphinx-build
1010
SPHINXBUILDDIR = docs/_build
1111
ALLSPHINXOPTS = -d $(SPHINXBUILDDIR)/doctrees $(SPHINXOPTS) docs/

docs/index.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ and see what changes after we call it
9797
MyBigFatObject 2 +2
9898
dict 797 +1
9999

100-
It's easy to see :class:`MyBigFatObject` instances that appeared and were
100+
It's easy to see ``MyBigFatObject`` instances that appeared and were
101101
not freed. I can pick one of them at random and trace the reference chain
102102
back to one of the garbage collector's roots.
103103

@@ -121,7 +121,7 @@ you've any examples where that isn't true, I'd love to hear about them
121121

122122
It is perhaps surprising to find :mod:`linecache` at the end of that chain
123123
(apparently :mod:`doctest` monkey-patches it), but the important things --
124-
:func:`computate_something` and its cache dictionary -- are in there.
124+
``computate_something`` and its cache dictionary -- are in there.
125125

126126
There are other tools, perhaps better suited for memory leak hunting:
127127
`heapy <https://pypi.python.org/pypi/guppy>`_,

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ commands =
2121
deps =
2222
Sphinx
2323
commands =
24-
sphinx-build -n -b html -d docs/_build/doctrees docs/ docs/_build/html
24+
sphinx-build -Wn -b html -d docs/_build/doctrees docs/ docs/_build/html
2525

2626
[testenv:livedocs]
2727
deps =

0 commit comments

Comments
 (0)