Re: [Mesa-dev] [PATCH 06/16] docs: Add Sphinx configuration file.

[Laura Ekstrand]

Eric,

Thanks for finding that command to shut off copyright.  I've updated the
series to add it.

Laura

On Fri, Jun 1, 2018 at 7:29 AM, Dylan Baker  wrote:

> Quoting Eric Engestrom (2018-06-01 02:41:36)
> > On Thursday, 2018-05-31 14:00:24 -0700, Dylan Baker wrote:
> > > Quoting Laura Ekstrand (2018-05-24 17:27:09)
> > > > From: Jean Hertel 
> > > >
> > > > This tells Sphinx how to build our website from reStructured Text.
> > > >
> > > > Signed-off-by: Jean Hertel 
> > > > ---
> > > >  docs/conf.py | 162 ++
> +
> > > >  1 file changed, 162 insertions(+)
> > > >  create mode 100644 docs/conf.py
> > > >
> > > > diff --git a/docs/conf.py b/docs/conf.py
> > > > new file mode 100644
> > > > index 00..dcdbdd51db
> > > > --- /dev/null
> > > > +++ b/docs/conf.py
> > > > @@ -0,0 +1,162 @@
> > > > +#!/usr/bin/env python3
> > > > +# -*- coding: utf-8 -*-
> > > > +
> > > > +import sphinx_rtd_theme
> > > > +
> > > > +#
> > > > +# The Mesa 3D Graphics Library documentation build configuration
> file, created by
> > > > +# sphinx-quickstart on Wed Mar 29 14:08:51 2017.
> > > > +#
> > > > +# 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('.'))
> > > > +
> > > > +
> > > > +# -- 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 = []
> > > > +
> > > > +# 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 = 'The Mesa 3D Graphics Library'
> > > > +copyright = '2017, Brian Paul'
> > > > +author = 'Brian Paul'
> > >
> > > Is this actually going to the final page?
> >
> > It's what appears at the bottom of every page.
> >
> > > Because this doesn't reflect the reality of the copyrights of mesa.
> >
> > Agreed; I think it's best left out, as there's no way to sanely reflect
> > the complex copyrights of mesa in a signature on each webpage. The
> > license page [1] already does that job.
> >
> > -copyright = '2017, Brian Paul'
> > +html_show_copyright = False
> >
> > [1] https://mesa3d.org/license.html
> >
>
> This seems like the most reasonable solution to me.
>
> Dylan
>
___
mesa-dev mailing list
mesa-dev@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/mesa-dev

Re: [Mesa-dev] [PATCH 06/16] docs: Add Sphinx configuration file.

[Dylan Baker]

Quoting Eric Engestrom (2018-06-01 02:41:36)
> On Thursday, 2018-05-31 14:00:24 -0700, Dylan Baker wrote:
> > Quoting Laura Ekstrand (2018-05-24 17:27:09)
> > > From: Jean Hertel 
> > > 
> > > This tells Sphinx how to build our website from reStructured Text.
> > > 
> > > Signed-off-by: Jean Hertel 
> > > ---
> > >  docs/conf.py | 162 
> > > +++
> > >  1 file changed, 162 insertions(+)
> > >  create mode 100644 docs/conf.py
> > > 
> > > diff --git a/docs/conf.py b/docs/conf.py
> > > new file mode 100644
> > > index 00..dcdbdd51db
> > > --- /dev/null
> > > +++ b/docs/conf.py
> > > @@ -0,0 +1,162 @@
> > > +#!/usr/bin/env python3
> > > +# -*- coding: utf-8 -*-
> > > +
> > > +import sphinx_rtd_theme
> > > +
> > > +#
> > > +# The Mesa 3D Graphics Library documentation build configuration file, 
> > > created by
> > > +# sphinx-quickstart on Wed Mar 29 14:08:51 2017.
> > > +#
> > > +# 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('.'))
> > > +
> > > +
> > > +# -- 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 = []
> > > +
> > > +# 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 = 'The Mesa 3D Graphics Library'
> > > +copyright = '2017, Brian Paul'
> > > +author = 'Brian Paul'
> > 
> > Is this actually going to the final page?
> 
> It's what appears at the bottom of every page.
> 
> > Because this doesn't reflect the reality of the copyrights of mesa.
> 
> Agreed; I think it's best left out, as there's no way to sanely reflect
> the complex copyrights of mesa in a signature on each webpage. The
> license page [1] already does that job.
> 
> -copyright = '2017, Brian Paul'
> +html_show_copyright = False
> 
> [1] https://mesa3d.org/license.html
> 

This seems like the most reasonable solution to me.

Dylan


signature.asc
Description: signature
___
mesa-dev mailing list
mesa-dev@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/mesa-dev

Re: [Mesa-dev] [PATCH 06/16] docs: Add Sphinx configuration file.

[Eric Engestrom]

On Thursday, 2018-05-31 14:00:24 -0700, Dylan Baker wrote:
> Quoting Laura Ekstrand (2018-05-24 17:27:09)
> > From: Jean Hertel 
> > 
> > This tells Sphinx how to build our website from reStructured Text.
> > 
> > Signed-off-by: Jean Hertel 
> > ---
> >  docs/conf.py | 162 
> > +++
> >  1 file changed, 162 insertions(+)
> >  create mode 100644 docs/conf.py
> > 
> > diff --git a/docs/conf.py b/docs/conf.py
> > new file mode 100644
> > index 00..dcdbdd51db
> > --- /dev/null
> > +++ b/docs/conf.py
> > @@ -0,0 +1,162 @@
> > +#!/usr/bin/env python3
> > +# -*- coding: utf-8 -*-
> > +
> > +import sphinx_rtd_theme
> > +
> > +#
> > +# The Mesa 3D Graphics Library documentation build configuration file, 
> > created by
> > +# sphinx-quickstart on Wed Mar 29 14:08:51 2017.
> > +#
> > +# 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('.'))
> > +
> > +
> > +# -- 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 = []
> > +
> > +# 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 = 'The Mesa 3D Graphics Library'
> > +copyright = '2017, Brian Paul'
> > +author = 'Brian Paul'
> 
> Is this actually going to the final page?

It's what appears at the bottom of every page.

> Because this doesn't reflect the reality of the copyrights of mesa.

Agreed; I think it's best left out, as there's no way to sanely reflect
the complex copyrights of mesa in a signature on each webpage. The
license page [1] already does that job.

-copyright = '2017, Brian Paul'
+html_show_copyright = False

[1] https://mesa3d.org/license.html

> 
> > +
> > +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
> > +
> > +# 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 = 'latest'
> > +# The full version, including alpha/beta/rc tags.
> > +release = 'latest'
> > +
> > +# 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 = 'sphinx_rtd_theme'
> > +
> > +# 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 

Re: [Mesa-dev] [PATCH 06/16] docs: Add Sphinx configuration file.

[Dylan Baker]

Quoting Laura Ekstrand (2018-05-24 17:27:09)
> From: Jean Hertel 
> 
> This tells Sphinx how to build our website from reStructured Text.
> 
> Signed-off-by: Jean Hertel 
> ---
>  docs/conf.py | 162 
> +++
>  1 file changed, 162 insertions(+)
>  create mode 100644 docs/conf.py
> 
> diff --git a/docs/conf.py b/docs/conf.py
> new file mode 100644
> index 00..dcdbdd51db
> --- /dev/null
> +++ b/docs/conf.py
> @@ -0,0 +1,162 @@
> +#!/usr/bin/env python3
> +# -*- coding: utf-8 -*-
> +
> +import sphinx_rtd_theme
> +
> +#
> +# The Mesa 3D Graphics Library documentation build configuration file, 
> created by
> +# sphinx-quickstart on Wed Mar 29 14:08:51 2017.
> +#
> +# 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('.'))
> +
> +
> +# -- 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 = []
> +
> +# 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 = 'The Mesa 3D Graphics Library'
> +copyright = '2017, Brian Paul'
> +author = 'Brian Paul'

Is this actually going to the final page? Because this doesn't reflect the
reality of the copyrights of mesa.

> +
> +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
> +
> +# 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 = 'latest'
> +# The full version, including alpha/beta/rc tags.
> +release = 'latest'
> +
> +# 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 = 'sphinx_rtd_theme'
> +
> +# 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 = 'TheMesa3DGraphicsLibrarydoc'
> +
> +
> +# -- 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, 

[Mesa-dev] [PATCH 06/16] docs: Add Sphinx configuration file.

[Laura Ekstrand]

From: Jean Hertel 

This tells Sphinx how to build our website from reStructured Text.

Signed-off-by: Jean Hertel 
---
 docs/conf.py | 162 +++
 1 file changed, 162 insertions(+)
 create mode 100644 docs/conf.py

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00..dcdbdd51db
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import sphinx_rtd_theme
+
+#
+# The Mesa 3D Graphics Library documentation build configuration file, created 
by
+# sphinx-quickstart on Wed Mar 29 14:08:51 2017.
+#
+# 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('.'))
+
+
+# -- 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 = []
+
+# 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 = 'The Mesa 3D Graphics Library'
+copyright = '2017, Brian Paul'
+author = 'Brian Paul'
+
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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 = 'latest'
+# The full version, including alpha/beta/rc tags.
+release = 'latest'
+
+# 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 = 'sphinx_rtd_theme'
+
+# 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 = 'TheMesa3DGraphicsLibrarydoc'
+
+
+# -- 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, 'TheMesa3DGraphicsLibrary.tex', 'The Mesa 3D Graphics Library 
Documentation',
+ 'Brian Paul', 'manual'),
+]
+
+
+# -- Options for manual page output ---
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).