[PATCH] D87242: [flang] Add new documentation main page

sameeran joshi via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Thu Sep 10 12:08:29 PDT 2020


sameeranjoshi added a comment.

In D87242#2266411 <https://reviews.llvm.org/D87242#2266411>, @richard.barton.arm wrote:

>> The TOC tree is displayed in the right `indexsidebar`, if it could be displayed at the top (see http://llvm.org/docs/CMake.html for reference) of individual pages that would be better and it would help reader initially to navigate to the internal section in the respective page.
>> Further I went on to apply `D87226`(contains a fixed side bar index links ) and the TOC disappears probably due to above mentioned issue.
>
> Can you help me understand what you mean here? When I build the pages they look like this to me:
> F12910087: image.png <https://reviews.llvm.org/F12910087>
>
> Compare that to the reference page you linked me to (same browser, same computer):
> F12910094: image.png <https://reviews.llvm.org/F12910094>
>
> I don't see a difference in the two for style. Both seem to have previous | next | index links in the top (and bottom) bars, as well as the indexsidebar as you point out. The indexsidebar seems to be a standard default from sphinx. LLVM uses a special one in llvm/docs/_templates/indexsidebar.html which does not have the previous/next topic links and instead has the permalinks to other articles.

I was talking about having the Table Of Contents which is in right pane to be in the center of page the way LLVM has.
Also when `D87226` would be applied, it would remove the TOC and will add other contents there.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D87242/new/

https://reviews.llvm.org/D87242



More information about the llvm-commits mailing list