This is an archive of the discontinued LLVM Phabricator instance.

	Show All 16 Lines
	// <root>/llvm/tools/clang/include/clang/Basic/Attr.td -o			// <root>/llvm/tools/clang/include/clang/Basic/Attr.td -o
	// <root>/llvm/tools/clang/docs/AttributeReference.rst			// <root>/llvm/tools/clang/docs/AttributeReference.rst
	//			//
	// To run sphinx to generate the .html files (note that sphinx-build must be			// To run sphinx to generate the .html files (note that sphinx-build must be
	// available on the PATH):			// available on the PATH):
	// Windows (from within the clang\docs directory):			// Windows (from within the clang\docs directory):
	// make.bat html			// make.bat html
	// Non-Windows (from within the clang\docs directory):			// Non-Windows (from within the clang\docs directory):
	// make -f Makefile.sphinx html			// sphinx-build -b html _build/html

	def GlobalDocumentation {			def GlobalDocumentation {
	code Intro =[{..			code Intro =[{..
	-------------------------------------------------------------------			-------------------------------------------------------------------
	NOTE: This file is automatically generated by running clang-tblgen			NOTE: This file is automatically generated by running clang-tblgen
	-gen-attr-docs. Do not edit this file by hand!!			-gen-attr-docs. Do not edit this file by hand!!
	-------------------------------------------------------------------			-------------------------------------------------------------------

	▲ Show 20 Lines • Show All 6,067 Lines • Show Last 20 Lines

llvm/docs/README.txt

	LLVM Documentation			LLVM Documentation
	==================			==================

	LLVM's documentation is written in reStructuredText, a lightweight			LLVM's documentation is written in reStructuredText, a lightweight
	plaintext markup language (file extension `.rst`). While the			plaintext markup language (file extension `.rst`). While the
	reStructuredText documentation should be quite readable in source form, it			reStructuredText documentation should be quite readable in source form, it
	is mostly meant to be processed by the Sphinx documentation generation			is mostly meant to be processed by the Sphinx documentation generation
	system to create HTML pages which are hosted on <https://llvm.org/docs/> and			system to create HTML pages which are hosted on <https://llvm.org/docs/> and
	updated after every commit. Manpage output is also supported, see below.			updated after every commit. Manpage output is also supported, see below.

	If you instead would like to generate and view the HTML locally, install			If you instead would like to generate and view the HTML locally, install
	Sphinx <http://sphinx-doc.org/> and then do:			Sphinx <http://sphinx-doc.org/> and then do:

	cd <build-dir>			cd <build-dir>
	cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>			cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
	make -j3 docs-llvm-html			make -j3 docs-llvm-html
	$BROWSER <build-dir>/docs//html/index.html			$BROWSER <build-dir>/docs/html/index.html

	The mapping between reStructuredText files and generated documentation is			The mapping between reStructuredText files and generated documentation is
	`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`.			`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`.

	If you are interested in writing new documentation, you will want to read			If you are interested in writing new documentation, you will want to read
	`SphinxQuickstartTemplate.rst` which will get you writing documentation			`SphinxQuickstartTemplate.rst` which will get you writing documentation
	very fast and includes examples of the most important reStructuredText			very fast and includes examples of the most important reStructuredText
	markup syntax.			markup syntax.

	Manpage Output			Manpage Output
	===============			===============

	Building the manpages is similar to building the HTML documentation. The			Building the manpages is similar to building the HTML documentation. The
	primary difference is to use the `man` makefile target, instead of the			primary difference is to use the `man` makefile target, instead of the
	default (which is `html`). Sphinx then produces the man pages in the			default (which is `html`). Sphinx then produces the man pages in the
	directory `<build-dir>/docs/man/`.			directory `<build-dir>/docs/man/`.

	cd <build-dir>			cd <build-dir>
	cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>			cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
	make -j3 docs-llvm-man			make -j3 docs-llvm-man
	man -l >build-dir>/docs/man/FileCheck.1			man -l <build-dir>/docs/man/FileCheck.1

	The correspondence between .rst files and man pages is			The correspondence between .rst files and man pages is
	`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.			`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
	These .rst files are also included during HTML generation so they are also			These .rst files are also included during HTML generation so they are also
	viewable online (as noted above) at e.g.			viewable online (as noted above) at e.g.
	`https://llvm.org/docs/CommandGuide/Foo.html`.			`https://llvm.org/docs/CommandGuide/Foo.html`.

	Checking links			Checking links
	==============			==============

	The reachability of external links in the documentation can be checked by			The reachability of external links in the documentation can be checked by
	running:			running:

	cd docs/			cd llvm/docs/
	make -f Makefile.sphinx linkcheck			sphinx-build -b linkcheck . _build/lintcheck/
				# report will be generated in _build/lintcheck/output.txt

	Doxygen page Output			Doxygen page Output
	==============			==============

	Install doxygen <https://www.doxygen.nl/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.			Install doxygen <https://www.doxygen.nl/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.

	cd <build-dir>			cd <build-dir>
	cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>			cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
	make doxygen-llvm # for LLVM docs			make doxygen-llvm # for LLVM docs
	make doxygen-clang # for clang docs			make doxygen-clang # for clang docs

	It will generate html in			It will generate html in

	<build-dir>/docs/doxygen/html # for LLVM docs			<build-dir>/docs/doxygen/html # for LLVM docs
	<build-dir>/tools/clang/docs/doxygen/html # for clang docs			<build-dir>/tools/clang/docs/doxygen/html # for clang docs

This is an archive of the discontinued LLVM Phabricator instance.

Replace references to Makefile.sphinxClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 381528

clang/include/clang/Basic/AttrDocs.td

llvm/docs/README.txt

Replace references to Makefile.sphinx
ClosedPublic