Techwriter at work blog.

Living and writing documentation at Documatt, small team of programmers that do write documentation too.


Inline literal start-string without end-string

Symptoms

Sphinx build failed with the error similar to:

WARNING: Inline literal start-string without end-string.

Reasons

Inline literal is a text used usually for code examples. It must start and end with double backtick ``. This error means you forgot to terminate inline literal with trailing ``.

Example

Name RetValue has missing trailing ``.

Exit code of a process is stored in the ``RetValue variable.

Solution

Enclose name RetValue by leading and trailing ``.

Exit code of a process is stored in the ``RetValue`` variable.

Comments

comments powered by Disqus