[llvm-dev] Is anyone experienced writing Sphinx documentation?

Zachary Turner via llvm-dev llvm-dev at lists.llvm.org
Thu Aug 10 18:45:26 PDT 2017


I feel incredibly stupid now because i was putting one : instead of two.
Sphinx doesn't even give an warning! Grr, so frustrating
On Thu, Aug 10, 2017 at 6:42 PM don hinton <hintonda at gmail.com> wrote:

> Try adding this just above SYNOPSIS (I think you also need to leave a
> blank line above and below):
>
> .. contents::
>    :local:
>
> hth...
> don
>
> On Thu, Aug 10, 2017 at 4:46 PM, Zachary Turner via llvm-dev <
> llvm-dev at lists.llvm.org> wrote:
>
>> I've read through the docs, but honestly this is driving me crazy and I
>> shouldn't have to fight this hard to just to write some documentation.
>>
>> Here's the problem:
>>
>> Look at llvm/docs/CommandGuide/FileCheck.rst
>>
>> I want to add a table of contents that looks like this [
>> http://llvm.org/docs/CMake.html] to that file.  Nothing I've tried
>> works.
>>
>> (Also, no I'm not trying to add it in FileCheck.rst specifically, but
>> rather in a new document that will be added to CommandGuide.  But if it
>> works in FileCheck.rst, it should work in my new document)
>>
>> _______________________________________________
>> LLVM Developers mailing list
>> llvm-dev at lists.llvm.org
>> http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20170811/c07e0f89/attachment.html>


More information about the llvm-dev mailing list