[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 <jean.hertel at hotmail.com>
> > > 
> > > This tells Sphinx how to build our website from reStructured Text.
> > > 
> > > Signed-off-by: Jean Hertel <jean.hertel at hotmail.com>
> > > ---
> > >  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 0000000000..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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 228 bytes
Desc: signature
URL: <https://lists.freedesktop.org/archives/mesa-dev/attachments/20180601/6a78b6b3/attachment.sig>