Source

sphinx / tests / root / includes.txt

Test file and literal inclusion
===============================

.. include:: subdir/include.inc

.. literalinclude:: literal.inc
   :language: python

.. should give a warning
.. literalinclude:: wrongenc.inc

.. should succeed
.. literalinclude:: wrongenc.inc
   :encoding: latin-1
.. include:: wrongenc.inc
   :encoding: latin-1


Testing downloadable files
==========================

Download :download:`img.png` here.
Download :download:`this <subdir/img.png>` there.
Don't download :download:`this <nonexisting.png>`.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.