<div dir="ltr"><div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr">On Wed, Jan 9, 2019 at 4:09 AM Stefan Gränitz <<a href="mailto:sgraenitz@apple.com">sgraenitz@apple.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div style="word-wrap:break-word;line-break:after-white-space">Hey Jonas that looks great! And what a nice way to do the review.<div><br></div><div>Two of the pages from "RESOURCES" are in the new docs now: Testing LLDB and The SB API Coding Rules</div><div>Will they be removed from the root page and/or do the others follow?</div><div><br></div><div>Added a few notes on escape characters to the review.</div></div></blockquote><div><br></div><div>Thanks! </div><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div style="word-wrap:break-word;line-break:after-white-space"><div><br></div><div><blockquote type="cite"><div dir="ltr"><div dir="ltr"><div>The biggest issue is that the GDB to LLDB command map is totally unreadable with the RST generated table. I spent a little time tweaking the CSS, but this needs some attention. Worst case we'll have to have an HTML table here. </div></div></div></blockquote><div><br></div><div>GDB to LLDB map is one of the most viewed pages in the docs right? I had a look and got the below result with a few CSS tweaks in the layout "debugger":</div><div><br></div><div> p, blockquote { margin-top: 0px; margin-bottom: 0px; }</div><div> tr.row-even { background: #eee; }</div><div> tr.row-odd td { font-family: monospace; padding-bottom: 15px; }</div><div> table.docutils { width: 100%; }</div><div><br></div></div></div></blockquote><div><br></div><div>Nice. I've added a custom class to these tables so we can limit these changes to only this table. I think this looks pretty good (you might have to clear your cache): <a href="https://jonasdevlieghere.com/static/lldb/use/map.html">https://jonasdevlieghere.com/static/lldb/use/map.html</a></div><div><br></div><div>I also managed to fix the column width, except for the first table. I'll have another look soon. </div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div style="word-wrap:break-word;line-break:after-white-space"><div><div></div><div>The last one sets full width on all tables. About columns having content-specific width, I am not sure. Might be interesting to see with a 50/50 setting in all <colgroup>'s.</div><div>Maybe we could also get rid of the column headers? The prompts say it all :)</div><div><br></div><div><img id="gmail-m_805183184512323592740B58EEB-FDAC-421D-AA5E-257F7D69458C" src="cid:1683384d73adb1c18e91"></div><div><br></div><div><br></div><div><blockquote type="cite"><div>On 8. Jan 2019, at 19:12, Jonas Devlieghere <<a href="mailto:jonas@devlieghere.com" target="_blank">jonas@devlieghere.com</a>> wrote:</div><br class="gmail-m_8051831845123235927Apple-interchange-newline"><div><div dir="ltr"><div dir="ltr"><div>For those interested, I've uploaded the latest version of the generated HTML:</div><div><br></div><div><a href="https://jonasdevlieghere.com/static/lldb/" target="_blank">https://jonasdevlieghere.com/static/lldb/</a><br></div><div><br></div><div>I'd have to double check but I think that almost everything was ported over. The biggest issue is that the GDB to LLDB command map is totally unreadable with the RST generated table. I spent a little time tweaking the CSS, but this needs some attention. Worst case we'll have to have an HTML table here. </div><div><br></div><div>Theme-wise I went with the one used by clang. I think it's the most readable and I personally really like the local ToC. The disadvantage is that it doesn't have a sidebar, so you have to navigate back to "contents" in the top right corner.</div><div><br></div><div>The alternative is the LLVM theme where we can have Sphinx generate the global ToC in the sidebar. When I tried this it was missing the section names (e.g. "Goals & Status" as seen on the main page). Another issue is that the local ToC gets totally lost beneath it because everything doesn't fit on the screen. Once I figure out how/if we can include the section names I'll generate the site with the LLVM theme so people can compare and give their opinion.</div><div><br></div><div>Cheers,</div><div>Jonas</div><div><br></div><div class="gmail_quote"><div dir="ltr">On Tue, Jan 8, 2019 at 9:31 AM Jonas Devlieghere <<a href="mailto:jonas@devlieghere.com" target="_blank">jonas@devlieghere.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr">On Tue, Jan 8, 2019 at 8:52 AM Stefan Gränitz via lldb-dev <<a href="mailto:lldb-dev@lists.llvm.org" target="_blank">lldb-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div style="word-wrap:break-word;line-break:after-white-space">Hi Jonas, I think this is a great effort. Thanks!<div><br></div><div>My current reviews do some small updates on the build page. Hope this doesn't get in conflict with your work?</div></div></blockquote><div><br></div><div>Thanks for the heads up Stefan. This should be fine, I'll copy over your change in the rst files. </div><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div style="word-wrap:break-word;line-break:after-white-space"><div><br></div><div>Best</div><div>Stefan<br><div><br><blockquote type="cite"><div>On 6. Dec 2018, at 18:02, Jonas Devlieghere via lldb-dev <<a href="mailto:lldb-dev@lists.llvm.org" target="_blank">lldb-dev@lists.llvm.org</a>> wrote:</div><br class="gmail-m_8051831845123235927gmail-m_-5338228392069351188gmail-m_1118832617541294990Apple-interchange-newline"><div><div style="word-wrap:break-word;line-break:after-white-space">Hi everyone,<div><br></div><div><div>The current LLDB website is written in HTML which is hard to maintain. We have quite a bit of HTML code checked in which can make it hard to differentiate between documentation written by us and documentation generated by a tool. Furthermore I think text/RST files provide a lower barrier for new or casual contributors to fix or update.</div><div><br></div><div>In line with the other LLVM projects I propose generating the documentation with Sphix. I created a patch (<a href="https://reviews.llvm.org/D55376" target="_blank">https://reviews.llvm.org/D55376</a>) that adds a new target docs-lldb-html when -DLLVM_ENABLE_SPHINX:BOOL is enabled. I've ported over some pages to give an idea of what this would look like in-tree. Before continuing with this rather tedious work I'd like to get feedback form the community.</div><div><br></div><div>Initially I started with the theme used by Clang because it's a default theme and doesn't require configuration. If we want to keep the sidebar we could use the one used by LLD.</div></div><div><br></div><div>Please let me know what you think.</div><div><br></div><div>Thanks,</div><div>Jonas</div></div>_______________________________________________<br>lldb-dev mailing list<br><a href="mailto:lldb-dev@lists.llvm.org" target="_blank">lldb-dev@lists.llvm.org</a><br><a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-dev" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-dev</a><br></div></blockquote></div><br></div></div>_______________________________________________<br>
lldb-dev mailing list<br>
<a href="mailto:lldb-dev@lists.llvm.org" target="_blank">lldb-dev@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-dev" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-dev</a><br>
</blockquote></div></div>
</blockquote></div></div></div>
</div></blockquote></div><br></div></div></blockquote></div></div></div>