diff options
author | Dylan Baker <dylan@pnwbakers.com> | 2016-12-15 14:54:22 -0800 |
---|---|---|
committer | Dylan Baker <dylan@pnwbakers.com> | 2016-12-19 11:32:38 -0800 |
commit | 70568620f84c83aa59bc0bdc40393d7348f0ff83 (patch) | |
tree | 9ad758878c6790ab13b0eee2ccc303b129b75ff2 | |
parent | 52098fada7e965479490045684b9897c623f5f76 (diff) |
Create a top level sphinx structure that includes gallium docs
This make a single toplevel sphinx directory that contains the make.bat
and Makefile for generating the sphinx documentation. This will be used
to handle nir and isl documentation in later commits.
-rw-r--r-- | sphinx/.gitignore | 1 | ||||
-rw-r--r-- | sphinx/Makefile | 20 | ||||
-rw-r--r-- | sphinx/make.bat | 36 | ||||
-rw-r--r-- | sphinx/source/conf.py | 157 | ||||
-rw-r--r-- | sphinx/source/exts/.gitignore | 3 | ||||
-rw-r--r-- | sphinx/source/exts/formatting.py (renamed from src/gallium/docs/source/exts/formatting.py) | 0 | ||||
l--------- | sphinx/source/gallium | 1 | ||||
-rw-r--r-- | sphinx/source/index.rst | 20 | ||||
-rw-r--r-- | src/gallium/docs/Makefile | 89 | ||||
-rw-r--r-- | src/gallium/docs/context.rst (renamed from src/gallium/docs/source/context.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/cso.rst (renamed from src/gallium/docs/source/cso.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/cso/blend.rst (renamed from src/gallium/docs/source/cso/blend.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/cso/dsa.rst (renamed from src/gallium/docs/source/cso/dsa.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/cso/rasterizer.rst (renamed from src/gallium/docs/source/cso/rasterizer.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/cso/sampler.rst (renamed from src/gallium/docs/source/cso/sampler.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/cso/shader.rst (renamed from src/gallium/docs/source/cso/shader.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/cso/velems.rst (renamed from src/gallium/docs/source/cso/velems.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/debugging.rst (renamed from src/gallium/docs/source/debugging.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/distro.rst (renamed from src/gallium/docs/source/distro.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers.rst (renamed from src/gallium/docs/source/drivers.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers/freedreno.rst (renamed from src/gallium/docs/source/drivers/freedreno.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers/freedreno/ir3-notes.rst (renamed from src/gallium/docs/source/drivers/freedreno/ir3-notes.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers/openswr.rst (renamed from src/gallium/docs/source/drivers/openswr.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers/openswr/faq.rst (renamed from src/gallium/docs/source/drivers/openswr/faq.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers/openswr/knobs.rst (renamed from src/gallium/docs/source/drivers/openswr/knobs.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers/openswr/profiling.rst (renamed from src/gallium/docs/source/drivers/openswr/profiling.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/drivers/openswr/usage.rst (renamed from src/gallium/docs/source/drivers/openswr/usage.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/format.rst (renamed from src/gallium/docs/source/format.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/glossary.rst (renamed from src/gallium/docs/source/glossary.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/index.rst (renamed from src/gallium/docs/source/index.rst) | 12 | ||||
-rw-r--r-- | src/gallium/docs/intro.rst (renamed from src/gallium/docs/source/intro.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/make.bat | 113 | ||||
-rw-r--r-- | src/gallium/docs/pipeline.txt (renamed from src/gallium/docs/source/pipeline.txt) | 0 | ||||
-rw-r--r-- | src/gallium/docs/resources.rst (renamed from src/gallium/docs/source/resources.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/screen.rst (renamed from src/gallium/docs/source/screen.rst) | 0 | ||||
-rw-r--r-- | src/gallium/docs/source/conf.py | 197 | ||||
-rw-r--r-- | src/gallium/docs/tgsi.rst (renamed from src/gallium/docs/source/tgsi.rst) | 0 |
37 files changed, 240 insertions, 409 deletions
diff --git a/sphinx/.gitignore b/sphinx/.gitignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/sphinx/.gitignore @@ -0,0 +1 @@ +build diff --git a/sphinx/Makefile b/sphinx/Makefile new file mode 100644 index 0000000000..482e26738b --- /dev/null +++ b/sphinx/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Mesa +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file diff --git a/sphinx/make.bat b/sphinx/make.bat new file mode 100644 index 0000000000..33803279df --- /dev/null +++ b/sphinx/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=Mesa
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/sphinx/source/conf.py b/sphinx/source/conf.py new file mode 100644 index 0000000000..01df4a9611 --- /dev/null +++ b/sphinx/source/conf.py @@ -0,0 +1,157 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Mesa documentation build configuration file, created by +# sphinx-quickstart on Thu Dec 15 14:41:17 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('exts')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.imgmath', 'sphinx.ext.graphviz', 'formatting'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Mesa' +copyright = '2016, The authors and/or copyright holders' +author = 'The authors and/or copyright holders' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '13.0' +# The full version, including alpha/beta/rc tags. +release = '13.0.2' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Mesadoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Mesa.tex', 'Mesa Documentation', + 'The authors and/or copyright holders', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'mesa', 'Mesa Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Mesa', 'Mesa Documentation', + author, 'Mesa', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/sphinx/source/exts/.gitignore b/sphinx/source/exts/.gitignore new file mode 100644 index 0000000000..c46f592d50 --- /dev/null +++ b/sphinx/source/exts/.gitignore @@ -0,0 +1,3 @@ +__pycache__ +*pyc +*pyo diff --git a/src/gallium/docs/source/exts/formatting.py b/sphinx/source/exts/formatting.py index 14865f3603..14865f3603 100644 --- a/src/gallium/docs/source/exts/formatting.py +++ b/sphinx/source/exts/formatting.py diff --git a/sphinx/source/gallium b/sphinx/source/gallium new file mode 120000 index 0000000000..8aa017e207 --- /dev/null +++ b/sphinx/source/gallium @@ -0,0 +1 @@ +../../src/gallium/docs
\ No newline at end of file diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst new file mode 100644 index 0000000000..147bf643ac --- /dev/null +++ b/sphinx/source/index.rst @@ -0,0 +1,20 @@ +.. Mesa documentation master file, created by + sphinx-quickstart on Thu Dec 15 14:41:17 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Mesa's documentation! +================================ + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + gallium/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/src/gallium/docs/Makefile b/src/gallium/docs/Makefile deleted file mode 100644 index d4a5be4192..0000000000 --- a/src/gallium/docs/Makefile +++ /dev/null @@ -1,89 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest - -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Gallium.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Gallium.qhc" - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/src/gallium/docs/source/context.rst b/src/gallium/docs/context.rst index e190cefc85..e190cefc85 100644 --- a/src/gallium/docs/source/context.rst +++ b/src/gallium/docs/context.rst diff --git a/src/gallium/docs/source/cso.rst b/src/gallium/docs/cso.rst index dab1ee50f3..dab1ee50f3 100644 --- a/src/gallium/docs/source/cso.rst +++ b/src/gallium/docs/cso.rst diff --git a/src/gallium/docs/source/cso/blend.rst b/src/gallium/docs/cso/blend.rst index 7316e5c71c..7316e5c71c 100644 --- a/src/gallium/docs/source/cso/blend.rst +++ b/src/gallium/docs/cso/blend.rst diff --git a/src/gallium/docs/source/cso/dsa.rst b/src/gallium/docs/cso/dsa.rst index 473d4f424e..473d4f424e 100644 --- a/src/gallium/docs/source/cso/dsa.rst +++ b/src/gallium/docs/cso/dsa.rst diff --git a/src/gallium/docs/source/cso/rasterizer.rst b/src/gallium/docs/cso/rasterizer.rst index 616e4511a2..616e4511a2 100644 --- a/src/gallium/docs/source/cso/rasterizer.rst +++ b/src/gallium/docs/cso/rasterizer.rst diff --git a/src/gallium/docs/source/cso/sampler.rst b/src/gallium/docs/cso/sampler.rst index 9959793a33..9959793a33 100644 --- a/src/gallium/docs/source/cso/sampler.rst +++ b/src/gallium/docs/cso/sampler.rst diff --git a/src/gallium/docs/source/cso/shader.rst b/src/gallium/docs/cso/shader.rst index 0ee42c8787..0ee42c8787 100644 --- a/src/gallium/docs/source/cso/shader.rst +++ b/src/gallium/docs/cso/shader.rst diff --git a/src/gallium/docs/source/cso/velems.rst b/src/gallium/docs/cso/velems.rst index 978ad4a243..978ad4a243 100644 --- a/src/gallium/docs/source/cso/velems.rst +++ b/src/gallium/docs/cso/velems.rst diff --git a/src/gallium/docs/source/debugging.rst b/src/gallium/docs/debugging.rst index 8e96a6e487..8e96a6e487 100644 --- a/src/gallium/docs/source/debugging.rst +++ b/src/gallium/docs/debugging.rst diff --git a/src/gallium/docs/source/distro.rst b/src/gallium/docs/distro.rst index 15468b6eeb..15468b6eeb 100644 --- a/src/gallium/docs/source/distro.rst +++ b/src/gallium/docs/distro.rst diff --git a/src/gallium/docs/source/drivers.rst b/src/gallium/docs/drivers.rst index 469197c233..469197c233 100644 --- a/src/gallium/docs/source/drivers.rst +++ b/src/gallium/docs/drivers.rst diff --git a/src/gallium/docs/source/drivers/freedreno.rst b/src/gallium/docs/drivers/freedreno.rst index 723ffdde14..723ffdde14 100644 --- a/src/gallium/docs/source/drivers/freedreno.rst +++ b/src/gallium/docs/drivers/freedreno.rst diff --git a/src/gallium/docs/source/drivers/freedreno/ir3-notes.rst b/src/gallium/docs/drivers/freedreno/ir3-notes.rst index 182508f0cc..182508f0cc 100644 --- a/src/gallium/docs/source/drivers/freedreno/ir3-notes.rst +++ b/src/gallium/docs/drivers/freedreno/ir3-notes.rst diff --git a/src/gallium/docs/source/drivers/openswr.rst b/src/gallium/docs/drivers/openswr.rst index 84aa51f5d8..84aa51f5d8 100644 --- a/src/gallium/docs/source/drivers/openswr.rst +++ b/src/gallium/docs/drivers/openswr.rst diff --git a/src/gallium/docs/source/drivers/openswr/faq.rst b/src/gallium/docs/drivers/openswr/faq.rst index 1d058f9222..1d058f9222 100644 --- a/src/gallium/docs/source/drivers/openswr/faq.rst +++ b/src/gallium/docs/drivers/openswr/faq.rst diff --git a/src/gallium/docs/source/drivers/openswr/knobs.rst b/src/gallium/docs/drivers/openswr/knobs.rst index 06f228a2e9..06f228a2e9 100644 --- a/src/gallium/docs/source/drivers/openswr/knobs.rst +++ b/src/gallium/docs/drivers/openswr/knobs.rst diff --git a/src/gallium/docs/source/drivers/openswr/profiling.rst b/src/gallium/docs/drivers/openswr/profiling.rst index 357754c350..357754c350 100644 --- a/src/gallium/docs/source/drivers/openswr/profiling.rst +++ b/src/gallium/docs/drivers/openswr/profiling.rst diff --git a/src/gallium/docs/source/drivers/openswr/usage.rst b/src/gallium/docs/drivers/openswr/usage.rst index e55b4211a5..e55b4211a5 100644 --- a/src/gallium/docs/source/drivers/openswr/usage.rst +++ b/src/gallium/docs/drivers/openswr/usage.rst diff --git a/src/gallium/docs/source/format.rst b/src/gallium/docs/format.rst index 93faf4fe1b..93faf4fe1b 100644 --- a/src/gallium/docs/source/format.rst +++ b/src/gallium/docs/format.rst diff --git a/src/gallium/docs/source/glossary.rst b/src/gallium/docs/glossary.rst index c749d0c955..c749d0c955 100644 --- a/src/gallium/docs/source/glossary.rst +++ b/src/gallium/docs/glossary.rst diff --git a/src/gallium/docs/source/index.rst b/src/gallium/docs/index.rst index dcf83992dc..49247b59ec 100644 --- a/src/gallium/docs/source/index.rst +++ b/src/gallium/docs/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Gallium's documentation! -=================================== +Gallium +======= Contents: @@ -22,11 +22,3 @@ Contents: distro drivers glossary - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/src/gallium/docs/source/intro.rst b/src/gallium/docs/intro.rst index 1ea103840a..1ea103840a 100644 --- a/src/gallium/docs/source/intro.rst +++ b/src/gallium/docs/intro.rst diff --git a/src/gallium/docs/make.bat b/src/gallium/docs/make.bat deleted file mode 100644 index 6f97e0730a..0000000000 --- a/src/gallium/docs/make.bat +++ /dev/null @@ -1,113 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -set SPHINXBUILD=sphinx-build -set BUILDDIR=build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^<target^>` where ^<target^> is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. changes to make an overview over all changed/added/deprecated items - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Gallium.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Gallium.ghc - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end diff --git a/src/gallium/docs/source/pipeline.txt b/src/gallium/docs/pipeline.txt index fd1fbe9c76..fd1fbe9c76 100644 --- a/src/gallium/docs/source/pipeline.txt +++ b/src/gallium/docs/pipeline.txt diff --git a/src/gallium/docs/source/resources.rst b/src/gallium/docs/resources.rst index e3e15f85f3..e3e15f85f3 100644 --- a/src/gallium/docs/source/resources.rst +++ b/src/gallium/docs/resources.rst diff --git a/src/gallium/docs/source/screen.rst b/src/gallium/docs/screen.rst index 7ac39ffc44..7ac39ffc44 100644 --- a/src/gallium/docs/source/screen.rst +++ b/src/gallium/docs/screen.rst diff --git a/src/gallium/docs/source/conf.py b/src/gallium/docs/source/conf.py deleted file mode 100644 index 5e8173d869..0000000000 --- a/src/gallium/docs/source/conf.py +++ /dev/null @@ -1,197 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Gallium documentation build configuration file, created by -# sphinx-quickstart on Sun Dec 20 14:09:05 2009. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.append(os.path.abspath('exts')) - -# -- General configuration ----------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.pngmath', 'sphinx.ext.graphviz', 'formatting'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Gallium' -copyright = u'2009-2012, VMware, X.org, Nouveau' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.4' -# The full version, including alpha/beta/rc tags. -release = '0.4' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# The language for highlighting source code. -highlight_language = 'c' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_use_modindex = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Galliumdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'Gallium.tex', u'Gallium Documentation', - u'VMware, X.org, Nouveau', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_use_modindex = True diff --git a/src/gallium/docs/source/tgsi.rst b/src/gallium/docs/tgsi.rst index d2d30b41d0..d2d30b41d0 100644 --- a/src/gallium/docs/source/tgsi.rst +++ b/src/gallium/docs/tgsi.rst |