[llvm-commits] [PATCH][Docs] Add HowToBuildOnARM.rst

[Sean Silva]

This is because LLD's docs/ directory contains just Sphinx docs, which
is different from LLVM's docs/ directory. The Makefile they have in
lld/docs/ was generated by sphinx-quickstart (or similar), which
outputs just the Sphinx makefile, called "Makefile". In the LLVM docs/
directory, however, the makefile generated by sphinx-quickstart was
named Makefile.sphinx because there was already a file called
"Makefile" in docs/ which builds the doxygen documentation and depends
on the configure/make build system.

I'm working on a "How To Write Sphinx Docs" document that should
explain all this.

--Sean Silva

On Thu, Sep 27, 2012 at 12:29 AM, 陳韋任 (Wei-Ren Chen)
<chenwj at iis.sinica.edu.tw> wrote:
> On Thu, Sep 27, 2012 at 12:16:30AM -0400, Sean Silva wrote:
>> No. You need to go into docs/ and then run `make -f Makefile.sphinx
>> html` (html is the default target, so you can also omit it). Then open
>> up docs/_build/html/index.html and navigate to the page to make sure
>> that everything is linked alright. Also check the generated HTML to
>> make sure that it is rendering how you expect.
>
>   I just found doc/README.txt talk about Sphinx. You might want to
> change `make html` to make -f Makefile.sphinx html` on [1], it takes
> me a while to figure out Makefile.sphinx is not the default makefile.
>
>   Micah, attach is the new patch which add a link to HowToBuildOnARM.rst.
> I have test it with Sphinx, please review.
>
> Regards,
> chenwj
>
> [1] http://lld.llvm.org/sphinx_intro.html#building-the-documentation
>
> --
> Wei-Ren Chen (陳韋任)
> Computer Systems Lab, Institute of Information Science,
> Academia Sinica, Taiwan (R.O.C.)
> Tel:886-2-2788-3799 #1667
> Homepage: http://people.cs.nctu.edu.tw/~chenwj