diff --git a/src/gallium/docs/source/_exts/formatting.py b/docs/_exts/formatting.py similarity index 100% rename from src/gallium/docs/source/_exts/formatting.py rename to docs/_exts/formatting.py diff --git a/docs/conf.py b/docs/conf.py index fe14ba731f0..27367654d47 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,9 +20,13 @@ import sphinx_rtd_theme # 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('.')) +import os +import sys + +# 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 ------------------------------------------------ @@ -34,7 +38,7 @@ import sphinx_rtd_theme # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['sphinx.ext.graphviz', 'formatting'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/contents.rst b/docs/contents.rst index c1cedf56fed..67246e3e014 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -68,6 +68,7 @@ release-calendar sourcedocs dispatch + gallium/index .. toctree:: :maxdepth: 1 diff --git a/src/gallium/docs/source/context.rst b/docs/gallium/context.rst similarity index 100% rename from src/gallium/docs/source/context.rst rename to docs/gallium/context.rst diff --git a/src/gallium/docs/source/cso.rst b/docs/gallium/cso.rst similarity index 100% rename from src/gallium/docs/source/cso.rst rename to docs/gallium/cso.rst diff --git a/src/gallium/docs/source/cso/blend.rst b/docs/gallium/cso/blend.rst similarity index 100% rename from src/gallium/docs/source/cso/blend.rst rename to docs/gallium/cso/blend.rst diff --git a/src/gallium/docs/source/cso/dsa.rst b/docs/gallium/cso/dsa.rst similarity index 100% rename from src/gallium/docs/source/cso/dsa.rst rename to docs/gallium/cso/dsa.rst diff --git a/src/gallium/docs/source/cso/rasterizer.rst b/docs/gallium/cso/rasterizer.rst similarity index 100% rename from src/gallium/docs/source/cso/rasterizer.rst rename to docs/gallium/cso/rasterizer.rst diff --git a/src/gallium/docs/source/cso/sampler.rst b/docs/gallium/cso/sampler.rst similarity index 100% rename from src/gallium/docs/source/cso/sampler.rst rename to docs/gallium/cso/sampler.rst diff --git a/src/gallium/docs/source/cso/shader.rst b/docs/gallium/cso/shader.rst similarity index 100% rename from src/gallium/docs/source/cso/shader.rst rename to docs/gallium/cso/shader.rst diff --git a/src/gallium/docs/source/cso/velems.rst b/docs/gallium/cso/velems.rst similarity index 100% rename from src/gallium/docs/source/cso/velems.rst rename to docs/gallium/cso/velems.rst diff --git a/src/gallium/docs/source/debugging.rst b/docs/gallium/debugging.rst similarity index 100% rename from src/gallium/docs/source/debugging.rst rename to docs/gallium/debugging.rst diff --git a/src/gallium/docs/source/distro.rst b/docs/gallium/distro.rst similarity index 100% rename from src/gallium/docs/source/distro.rst rename to docs/gallium/distro.rst diff --git a/src/gallium/docs/source/drivers.rst b/docs/gallium/drivers.rst similarity index 100% rename from src/gallium/docs/source/drivers.rst rename to docs/gallium/drivers.rst diff --git a/src/gallium/docs/source/drivers/freedreno.rst b/docs/gallium/drivers/freedreno.rst similarity index 100% rename from src/gallium/docs/source/drivers/freedreno.rst rename to docs/gallium/drivers/freedreno.rst diff --git a/src/gallium/docs/source/drivers/freedreno/ir3-notes.rst b/docs/gallium/drivers/freedreno/ir3-notes.rst similarity index 100% rename from src/gallium/docs/source/drivers/freedreno/ir3-notes.rst rename to docs/gallium/drivers/freedreno/ir3-notes.rst diff --git a/src/gallium/docs/source/drivers/openswr.rst b/docs/gallium/drivers/openswr.rst similarity index 100% rename from src/gallium/docs/source/drivers/openswr.rst rename to docs/gallium/drivers/openswr.rst diff --git a/src/gallium/docs/source/drivers/openswr/faq.rst b/docs/gallium/drivers/openswr/faq.rst similarity index 100% rename from src/gallium/docs/source/drivers/openswr/faq.rst rename to docs/gallium/drivers/openswr/faq.rst diff --git a/src/gallium/docs/source/drivers/openswr/knobs.rst b/docs/gallium/drivers/openswr/knobs.rst similarity index 100% rename from src/gallium/docs/source/drivers/openswr/knobs.rst rename to docs/gallium/drivers/openswr/knobs.rst diff --git a/src/gallium/docs/source/drivers/openswr/profiling.rst b/docs/gallium/drivers/openswr/profiling.rst similarity index 100% rename from src/gallium/docs/source/drivers/openswr/profiling.rst rename to docs/gallium/drivers/openswr/profiling.rst diff --git a/src/gallium/docs/source/drivers/openswr/usage.rst b/docs/gallium/drivers/openswr/usage.rst similarity index 100% rename from src/gallium/docs/source/drivers/openswr/usage.rst rename to docs/gallium/drivers/openswr/usage.rst diff --git a/src/gallium/docs/source/format.rst b/docs/gallium/format.rst similarity index 100% rename from src/gallium/docs/source/format.rst rename to docs/gallium/format.rst diff --git a/src/gallium/docs/source/glossary.rst b/docs/gallium/glossary.rst similarity index 100% rename from src/gallium/docs/source/glossary.rst rename to docs/gallium/glossary.rst diff --git a/src/gallium/docs/source/index.rst b/docs/gallium/index.rst similarity index 100% rename from src/gallium/docs/source/index.rst rename to docs/gallium/index.rst diff --git a/src/gallium/docs/source/intro.rst b/docs/gallium/intro.rst similarity index 100% rename from src/gallium/docs/source/intro.rst rename to docs/gallium/intro.rst diff --git a/src/gallium/docs/source/pipeline.txt b/docs/gallium/pipeline.txt similarity index 100% rename from src/gallium/docs/source/pipeline.txt rename to docs/gallium/pipeline.txt diff --git a/src/gallium/docs/source/resources.rst b/docs/gallium/resources.rst similarity index 100% rename from src/gallium/docs/source/resources.rst rename to docs/gallium/resources.rst diff --git a/src/gallium/docs/source/screen.rst b/docs/gallium/screen.rst similarity index 100% rename from src/gallium/docs/source/screen.rst rename to docs/gallium/screen.rst diff --git a/src/gallium/docs/source/tgsi.rst b/docs/gallium/tgsi.rst similarity index 100% rename from src/gallium/docs/source/tgsi.rst rename to docs/gallium/tgsi.rst diff --git a/src/gallium/docs/Makefile b/src/gallium/docs/Makefile deleted file mode 100644 index d4a5be41922..00000000000 --- 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 ' where 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/make.bat b/src/gallium/docs/make.bat deleted file mode 100644 index 6f97e0730a7..00000000000 --- 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 ^` where ^ 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/conf.py b/src/gallium/docs/source/conf.py deleted file mode 100644 index a8aa6fb70bf..00000000000 --- 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.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 = 'none' - -# 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 -# " v 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 = [] - -# 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 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