IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2797 from shibukawa/fix/sphinxdoc

Browse Source 
fix document download roles. download roles works only on html.
This commit is contained in:
Takeshi KOMIYA
2016-07-20 23:24:38 +09:00
committed by GitHub
parent 9916518fee b7b1ac1c4d
commit 8d8e35a043
3 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/ext/example_google.rst
View File

@@ -9,7 +9,9 @@ Example Google Style Python Docstrings
:ref:`example_numpy` :ref:`example_numpy`
Download: :download:`example_google.py <example_google.py>` .. only:: builder_html
Download: :download:`example_google.py <example_google.py>`
.. literalinclude:: example_google.py .. literalinclude:: example_google.py
:language: python :language: python

4
doc/ext/example_numpy.rst
View File

@@ -9,7 +9,9 @@ Example NumPy Style Python Docstrings
:ref:`example_google` :ref:`example_google`
Download: :download:`example_numpy.py <example_numpy.py>` .. only:: builder_html
Download: :download:`example_numpy.py <example_numpy.py>`
.. literalinclude:: example_numpy.py .. literalinclude:: example_numpy.py
:language: python :language: python

6
doc/markup/inline.rst
View File

@@ -200,6 +200,12 @@ Referencing downloadable files
The ``example.py`` file will be copied to the output directory, and a The ``example.py`` file will be copied to the output directory, and a
suitable link generated to it. suitable link generated to it.
Not to show unavailable download links, you should wrap whole paragraphs that
have this role::
.. only:: builder_html
See :download:`this example script <../example.py>`.
Cross-referencing figures by figure number Cross-referencing figures by figure number
------------------------------------------ ------------------------------------------