1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
===============
Troubleshooting
===============
The code-include is not showing up. What do I do?
=================================================
Add Fallback Text
+++++++++++++++++
If you add ``:fallback-text:`` to your ``code-include`` directive, even if your
target is missing, ``code-include`` will still always show something.
::
.. code-include :: :func:`foo`
Enable Logging
++++++++++++++
Instead of building your sphinx documentation with a command like
.. code-block:: sh
sphinx-build documentation/source documentation/build
Try using
.. code-block:: sh
LOG_LEVEL=0 sphinx-build documentation/source documentation/build
``code-include`` comes with logging messages and ``$LOG_LEVEL`` controls the verbosity.
0 = all+ (show everything)
10 = debug+ (very verbose)
20 = info+ (useful messages)
30 = warning+ (a message indicating a cause for concern)
40 = errors+ (something broke in an unrecoverable way)
Enable Exceptions
+++++++++++++++++
``code-include`` by default doesn't prevent docs from building if an exception is found.
You can disable this (e.g. raise exceptions) by adding this to your ``conf.py``:
.. code-block:: python
code_include_reraise = True
|
