ReST questions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

I'm trying to render the ascii-art in lib/textsearch.c "ARCHITECTURE" (block diagram):

 * ARCHITECTURE
 * .. code-block:: none
 *
 *     User
 *     +----------------+
 *     |        finish()|<--------------(6)-----------------+
 *     |get_next_block()|<--------------(5)---------------+ |
 *     |                |                     Algorithm   | |
 *     |                |                    +------------------------------+
 *     |                |                    |  init()   find()   destroy() |
 *     |                |                    +------------------------------+
 *     |                |       Core API           ^       ^          ^
 *     |                |      +---------------+  (2)     (4)        (8)
 *     |             (1)|----->| prepare()     |---+       |          |
 *     |             (3)|----->| find()/next() |-----------+          |
 *     |             (7)|----->| destroy()     |----------------------+
 *     +----------------+      +---------------+
 *

but Sphinx has 2 issues about it (or maybe one of them is my issue).

(1) It sees the |...| as inline substitutions without a reference.

../lib/textsearch.c:26: WARNING: Inline substitution_reference start-string without end-string.
../lib/textsearch.c:26: ERROR: Undefined substitution referenced: "---+ | | | (3)".
../lib/textsearch.c:26: ERROR: Undefined substitution referenced: "-----------+ | | (7)".

(2) It wants to preface each "function" in the "art" with ":c:func:" and put
back-quote marks around each function name, like `finish()`.  That makes the ASCII art
unreadable.

I have tried :: by itself and .. code-block:: none
without success.

Is there a way to prevent this :c:func: enhancing?
Is there a way to disable the |...| inline substitution attempts?

thanks.
-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux