sphinx / tests / root / includes.txt

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

Download :download:`img.png` here.
Download :download:`this <subdir/img.png>` there.
Don't download :download:`this <nonexisting.png>`.

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

.. include:: subdir/include.inc

.. 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

Literalinclude options
======================

.. highlight:: text

.. cssclass:: inc-pyobj1
.. literalinclude:: literal.inc
   :pyobject: Foo

.. cssclass:: inc-pyobj2
.. literalinclude:: literal.inc
   :pyobject: Bar.baz

.. cssclass:: inc-lines
.. literalinclude:: literal.inc
   :lines: 6-7,9

.. cssclass:: inc-startend
.. literalinclude:: literal.inc
   :start-after: coding: utf-8
   :end-before: class Foo

.. cssclass:: inc-preappend
.. literalinclude:: literal.inc
   :prepend: START CODE
   :append: END CODE

.. literalinclude:: literal.inc
   :start-after: utf-8

.. literalinclude:: literal.inc
   :end-before: class Foo

.. cssclass:: inc-tab3
.. literalinclude:: tabs.inc
   :tab-width: 3
   :language: text

.. cssclass:: inc-tab8
.. literalinclude:: tabs.inc
   :tab-width: 8
   :language: python

Test if dedenting before parsing works.

.. highlight:: python

.. cssclass:: inc-pyobj-dedent
.. literalinclude:: literal.inc
   :pyobject: Bar.baz

Docutils include with "literal"
===============================

While not recommended, it should work (and leave quotes alone).

.. include:: quotes.inc
   :literal:
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.