Skip to content

Commit 2b417c7

Browse files
committed
ENH(site): put |substs| in rst_epilog config ...
to stop requiring README's' tail inclusion.
1 parent 485b462 commit 2b417c7

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

README.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,10 @@ Run the graph and request all of the outputs:
118118
:alt: graphtik legend
119119
:align: middle
120120

121-
.. _substs:
122121

123122
.. _Graphkit: https://github.com/yahoo/graphkit
124-
.. _`Graphviz`: https://graphviz.org
125-
.. _`pydot`: https://github.com/pydot/pydot
123+
.. _Graphviz: https://graphviz.org
124+
.. _badges_substs:
126125

127126
.. |travis-status| image:: https://img.shields.io/travis/pygraphkit/graphtik
128127
:alt: Travis continuous integration testing ok? (Linux)

docs/source/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,14 @@ def linkcode_resolve(domain, info):
121121
return uri
122122

123123

124+
rst_epilog = """
125+
.. _Graphkit: https://github.com/yahoo/graphkit
126+
.. _Graphviz: https://graphviz.org
127+
.. _pydot: https://github.com/pydot/pydot
128+
.. |pydot.Dot| replace:: ``pydot.Dot``
129+
.. _pydot.Dot: https://github.com/pydot/pydot
130+
"""
131+
124132
# Add any paths that contain templates here, relative to this directory.
125133
templates_path = ["_templates"]
126134

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ Solutions are plottable as well:
124124
.. |plot-legend| raw:: html
125125
:file: images/GraphtikLegend.svg
126126
.. include:: ../../README.rst
127-
:start-after: _substs:
127+
:start-after: _badges_substs:

0 commit comments

Comments
 (0)