riscv
/
skywater-pdk
mirror of https://github.com/google/skywater-pdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Small cleanup of auto-generated name outputs. 

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
This commit is contained in:
Tim 'mithro' Ansell 2020-06-18 16:14:15 -07:00
parent 0f9c5cafec
commit 83779dee6a
1 changed files with 42 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
docs/conf.py
View File

@ -37,9 +37,9 @@ import re
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'Skywater SKY130 PDK' project = 'SkyWater SKY130 PDK'
copyright = '2020, Skywater PDK Authors' copyright = '2020, SkyWater PDK Authors'
author = 'Skywater PDK Authors' author = 'SkyWater PDK Authors'
# The short X.Y version # The short X.Y version
version = '' version = ''
@ -172,36 +172,27 @@ html_theme_options = {
# #
# Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue, # Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue,
# light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo) # light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo)
'primary_color': 'primary_color': 'light_green',
'light_green',
# Values: Same as primary_color. (Default: pink) # Values: Same as primary_color. (Default: pink)
'accent_color': 'accent_color': 'teal',
'teal',
# Customize layout. # Customize layout.
# For details see link. # For details see link.
# https://getmdl.io/components/index.html#layout-section # https://getmdl.io/components/index.html#layout-section
'fixed_drawer': 'fixed_drawer': True,
True, 'fixed_header': True,
'fixed_header': 'header_waterfall': True,
True, 'header_scroll': False,
'header_waterfall':
True,
'header_scroll':
False,
# Render title in header. # Render title in header.
# Values: True, False (Default: False) # Values: True, False (Default: False)
'show_header_title': 'show_header_title': False,
False,
# Render title in drawer. # Render title in drawer.
# Values: True, False (Default: True) # Values: True, False (Default: True)
'show_drawer_title': 'show_drawer_title': True,
True,
# Render footer. # Render footer.
# Values: True, False (Default: True) # Values: True, False (Default: True)
'show_footer': 'show_footer': True
True
} }
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
@ -216,12 +207,11 @@ html_static_path = ['_static']
# defined by theme itself. Builtin themes are using these templates by # defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``. # 'searchbox.html']``.
#
# -- Options for HTMLHelp output --------------------------------------------- # -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'SkywaterSKY130PDKdoc' htmlhelp_basename = 'skywater-pdk-doc'
# -- Options for LaTeX output ------------------------------------------------ # -- Options for LaTeX output ------------------------------------------------
@ -248,17 +238,26 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'SkywaterSKY130PDK.tex', 'Skywater SKY130 PDK Documentation', (
'Skywater PDK Authors', 'manual'), # source start file
master_doc,
# target name
'skywater-pdk.tex',
# title
'SkyWater SKY130 PDK Documentation',
# author
author,
# document class
'manual',
),
] ]
# -- Options for manual page output ------------------------------------------ # -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'skywaters8pdk', 'Skywater SKY130 PDK Documentation', (master_doc, 'skywater-pdk', 'SkyWater SKY130 PDK Documentation',
[author], 1) [author], 1)
] ]
@ -269,12 +268,24 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'SkywaterSKY130PDK', 'Skywater SKY130 PDK Documentation', (
author, 'SkywaterSKY130PDK', 'One line description of project.', # source start file
'Miscellaneous'), master_doc,
# target name
'skywater-pdk',
# title
'SkyWater SKY130 PDK Documentation',
# author
author,
# dir menu entry
'SkyWater SKY130 PDK',
# description
'Documentation for open source PDK targetting SkyWater SKY130 process node.',
# category
'Miscellaneous',
),
] ]
# -- Options for Epub output ------------------------------------------------- # -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info. # Bibliographic Dublin Core info.
@ -292,7 +303,6 @@ epub_title = project
# A list of files that should not be packed into the epub file. # A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html'] epub_exclude_files = ['search.html']
# -- Extension configuration ------------------------------------------------- # -- Extension configuration -------------------------------------------------
# -- Options for todo extension ---------------------------------------------- # -- Options for todo extension ----------------------------------------------