microsoft
/
clang-1
зеркало из https://github.com/microsoft/clang-1.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
clang-1/docs/index.rst

74 строки
1.1 KiB
ReStructuredText
Исходник Обычный вид История

docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170042 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-13 03:02:30 +04:00
.. Clang documentation master file, created by
sphinx-quickstart on Sun Dec 9 20:01:55 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171417 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-03 01:50:48 +04:00
.. title:: Welcome to Clang's documentation!
docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170042 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-13 03:02:30 +04:00
.. toctree::
docs: Decrease toctree depth on landing page. Having the table of contents there was making it hard to easily see at a glance all the docs we have. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171376 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:39:50 +04:00
:maxdepth: 1
docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170042 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-13 03:02:30 +04:00
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
ReleaseNotes
Using Clang as a Compiler
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171417 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-03 01:50:48 +04:00
=========================
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
.. toctree::
:maxdepth: 1
UsersManual
docs: Reorganize landing page. Language extensions are highly relevant to using clang as a compiler, so move LanguageExtensions up into `Using Clang as a Compiler` on the landing page. The other documents from the now-gone `Language Extensions and Specs` section on the landing page nicely fit hierarchically under LanguageExtensions.rst, so put them under LanguageExtensions.rst's toctree instead of on the landing page. Impetus from Jordan Rose. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171409 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-03 01:03:11 +04:00
LanguageExtensions
docs: More reST conversion. Sorry for the large commit, but it is much faster to convert in batches. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170067 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-13 05:10:46 +04:00
AddressSanitizer
Documentation: add MemorySanitizer to the toctree git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171003 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-23 22:35:58 +04:00
ThreadSanitizer
MemorySanitizer
More documentation on the module map language. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@177704 91177308-0d34-0410-b5e6-96231b3b80d8
2013-03-22 10:21:35 +04:00
Modules
Clang docs: add some information about the difference between 'clang' and 'clang -cc1' This is coming up again and again on the mailing list and IRC. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171656 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-06 17:38:34 +04:00
FAQ
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
Using Clang as a Library
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171417 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-03 01:50:48 +04:00
========================
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
.. toctree::
:maxdepth: 1
Tooling
[docs] Rename to permit wider variety of content. I don't want to rule out the possibility of linking to e.g. interesting blog posts about uses of Clang, so avoid restricting the content to "projects". This breaks URL compatibility, but this document was committed less than an hour ago so hopefully nobody has linked to it yet. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@175535 91177308-0d34-0410-b5e6-96231b3b80d8
2013-02-19 21:29:01 +04:00
ExternalClangExamples
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
IntroductionToTheClangAST
LibTooling
Add documentation for clang-format. This adds documentation for both LibFormat as well as the standalone tools and integrations built on top of it. It slightly restructures the ClangTools documentation. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@172004 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-10 01:49:28 +04:00
LibFormat
docs: More reST conversion. Sorry for the large commit, but it is much faster to convert in batches. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170067 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-13 05:10:46 +04:00
ClangPlugins
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
RAVFrontendAction
LibASTMatchersTutorial
LibASTMatchers
docs: More reST conversion. Sorry for the large commit, but it is much faster to convert in batches. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170067 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-13 05:10:46 +04:00
HowToSetupToolingForLLVM
JSONCompilationDatabase
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
Add documentation for clang-format. This adds documentation for both LibFormat as well as the standalone tools and integrations built on top of it. It slightly restructures the ClangTools documentation. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@172004 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-10 01:49:28 +04:00
Using Clang Tools
=================
.. toctree::
:maxdepth: 1
ClangTools
ClangCheck
ClangFormat
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
Design Documents
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171417 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-03 01:50:48 +04:00
================
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
.. toctree::
:maxdepth: 1
Documentation: convert InternalsManual.html to reST Patch by Anastasi Voitova with with small fixes by me. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170275 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-16 00:41:17 +04:00
InternalsManual
docs: Convert DriverInternals to reST. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170812 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-21 04:16:53 +04:00
DriverInternals
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171379 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-02 16:41:24 +04:00
PTHInternals
PCHInternals
docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@170042 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-13 03:02:30 +04:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`