llvm-capstone/lldb/docs/index.rst
Jonas Devlieghere d44a7be17b [Docs] Move API docs to the front page
This moves the links to the C++ and Python API docs up to the main page.
As of now the links are still broken [1], but at least this will prevent
the additional frustration of searching for the links only to find out
they're broken.

[1] http://lists.llvm.org/pipermail/lldb-dev/2019-April/014992.html

llvm-svn: 358928
2019-04-22 22:41:55 +00:00

73 lines
1.4 KiB
ReStructuredText

.. title:: Welcome to LLDB's documentation!
LLDB
====
LLDB is a next generation, high-performance debugger. It is built as a set of
reusable components which highly leverage existing libraries in the larger LLVM
Project, such as the Clang expression parser and LLVM disassembler.
LLDB is the default debugger in Xcode on macOS and supports debugging C,
Objective-C and C++ on the desktop and iOS devices and simulator.
All of the code in the LLDB project is available under the standard
`LLVM License <http://llvm.org/docs/DeveloperPolicy.html#copyright-license-and-patents>`__,
an open source "BSD-style" license.
Goals & Status
==============
.. toctree::
:maxdepth: 1
status/about
status/goals
status/features
status/status
status/projects
Use & Extension
===============
.. toctree::
:maxdepth: 1
use/tutorial
use/map
use/formatting
use/variable
use/symbolication
use/symbols
use/python
use/remote
use/troubleshooting
use/architecture
Resources
=========
.. toctree::
:maxdepth: 1
resources/download
resources/build
resources/source
resources/test
resources/bots
resources/sbapi
resources/external
API Documentation
=================
* `Python API Documentation <https://lldb.llvm.org/python_reference/index.html>`_
* `C++ API Documentation <https://lldb.llvm.org/cpp_reference/html/index.html>`_
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`