diff options
author | Jordan Justen <jordan.l.justen@intel.com> | 2018-12-17 01:12:51 -0800 |
---|---|---|
committer | Jordan Justen <jordan.l.justen@intel.com> | 2018-12-17 23:39:58 -0800 |
commit | af991778628e79daa1b3ecc10f48c2082d210f0b (patch) | |
tree | 38b00d93577c6ec43b9bf8f311ddde515a9c8db4 /docs | |
parent | 2ef8a99e8ea4a3a7b832cbea5a6420bf178b43a1 (diff) |
conf.py: Customize for the Piglit project
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/docs/conf.py b/docs/conf.py index f4b787589..a17f7533c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -53,18 +53,18 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Sphinx Example Project' -copyright = u'2016, John Doe' -author = u'John Doe' +project = u'Piglit' +copyright = u'2018, freedesktop.org' +author = u'freedesktop.org' # 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 = u'0' +#version = u'0' # The full version, including alpha/beta/rc tags. -release = u'1' +#release = u'1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -139,6 +139,7 @@ html_theme = 'alabaster' # "<project> v<release> documentation" by default. # # html_title = u'Sphinx Example Project v1' +html_title = None # A shorter title for the navigation bar. Default is the same as html_title. # @@ -158,7 +159,7 @@ html_theme = 'alabaster' # 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'] +#html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -180,6 +181,7 @@ html_static_path = ['_static'] # Custom sidebar templates, maps document names to template names. # # html_sidebars = {} +html_sidebars = { '**': [ ] } # Additional templates that should be rendered to pages, maps page names to # template names. @@ -189,10 +191,12 @@ html_static_path = ['_static'] # If false, no module index is generated. # # html_domain_indices = True +html_domain_indices = False # If false, no index is generated. # # html_use_index = True +html_use_index = False # If true, the index is split into individual pages for each letter. # @@ -201,14 +205,17 @@ html_static_path = ['_static'] # If true, links to the reST sources are added to the pages. # # html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # # html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # # html_show_copyright = True +html_show_copyright = False # 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 @@ -238,7 +245,7 @@ html_static_path = ['_static'] # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'SphinxExampleProjectdoc' +htmlhelp_basename = 'PiglitProjectdoc' # -- Options for LaTeX output --------------------------------------------- @@ -264,7 +271,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'SphinxExampleProject.tex', u'Sphinx Example Project Documentation', + (master_doc, 'PiglitProject.tex', u'Piglit Project Documentation', u'John Doe', 'manual'), ] @@ -306,7 +313,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'sphinxexampleproject', u'Sphinx Example Project Documentation', + (master_doc, 'piglitproject', u'Piglit Project Documentation', [author], 1) ] @@ -321,8 +328,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'SphinxExampleProject', u'Sphinx Example Project Documentation', - author, 'SphinxExampleProject', 'One line description of project.', + (master_doc, 'PiglitProject', u'Piglit Project Documentation', + author, 'PiglitProject', 'One line description of project.', 'Miscellaneous'), ] |