question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Resolve documentation build warnings: Inline emphasis start-string without end-string

See original GitHub issue

Mattermost product documentation is written in RST, generated using Sphinx, and formatted using a Sphinx theme called ReadTheDocs.

When the documentation builds, the following common Sphinx build warning is returned:

  • Inline emphasis start-string without end-string

The Technical Writing team welcomes some assistance identifying what’s causing this warning in the content source files, how to resolve the warning, and how to avoid the warning altogether going forward with new content development.

VS Code-based linters and other RST format checking tools compatible with Sphinx 3.4.3 and later are also most welcome additions to our existing toolset.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
larkoxcommented, Jul 30, 2021

May I take this one?

1reaction
haardikdharma10commented, Jul 29, 2021

Hey @cwarnermm, I am no Sphinx expert but don’t know if you have gone through this discussion already, if not, this can be of help:

https://github.com/fish-shell/fish-shell/pull/7520

Read more comments on GitHub >

github_iconTop Results From Across the Web

Building sphinx-docs from source gives warning, "Inline ...
When building from source (3.1.2-1706-geb592092a) on macOS Big Sur, ... gives warning, "Inline emphasis start-string without end-string.
Read more >
Inline literal start-string without end-string - Tech writer blog
Symptoms¶. Sphinx build failed with the error similar to: WARNING: Inline literal start-string without end-string.
Read more >
A literal "*" in RestructuredText - python - Stack Overflow
And as soon as I run Sphinx, I get the oh-so helpful error: WARNING: Inline literal start-string without end-string. So, I tried param...
Read more >
Minor warning messages when compiling documentation
When I build the documentation on the current CPython code, ... Misc/NEWS:659: WARNING: Inline emphasis start-string without end-string.
Read more >
Sphinx: fix 'Inline emphasis start-string without end ... - Manticore
Sphinx: fix 'Inline emphasis start-string without end-string' ; 207, +* Improved documentation for SSE/AVX intrinsics in intrin.h header files.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found