[Lldb-commits] [PATCH] D104281: [lldb][docs] Add reference docs for Lua scripting

[Siger Young via Phabricator via lldb-commits]

siger-young added inline comments.


================
Comment at: lldb/docs/conf.py:32-33
     # set by CMake.
-    sys.path.insert(0, os.getenv("LLDB_SWIG_MODULE"))
+    if os.getenv("LLDB_SWIG_MODULE") is not None:
+        sys.path.insert(0, os.getenv("LLDB_SWIG_MODULE"))
 
----------------
JDevlieghere wrote:
> Why is this necessary? It sounds like CMake should be setting this variable.
At the beginning, I was using `ninja lldb-docs-html` to build the docs. But it seems that it will build all of the docs each time it runs. It wastes some time, so I turn to `sphinx-build` command to build it, thus the env might become `None`. If extension `sphinx_tabs.tabs` is added, `None` value in `sys.path` will affect its importing.


================
Comment at: lldb/docs/conf.py:64-77
 try:
-  import recommonmark
+    import recommonmark
 except ImportError:
-  # manpages do not use any .md sources
-  if not building_man_page:
-    raise
+    # manpages do not use any .md sources
+    if not building_man_page:
+        raise
 else:
----------------
JDevlieghere wrote:
> Unrelated change? 
Yes, it's unrelated.


================
Comment at: lldb/docs/conf.py:180-182
+# Add any extra stylesheets and scripts here.
+html_css_files = ['lldb.css']
+html_js_files = []
----------------
JDevlieghere wrote:
> Why is this necessary?
When I built the docs using the `html_context`, the final pages only include `lldb.css`, missing files from theme e.g. `alabaster.css`.


================
Comment at: lldb/docs/conf.py:306-308
+    ('index', 'LLDB', u'LLDB Documentation',
+     u'The LLDB Team', 'LLDB', 'One line description of project.',
+     'Miscellaneous'),
----------------
JDevlieghere wrote:
> Unrelated whitespace change?
Yes.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D104281