add more to docs | 1st spelling pass | more links | proper formatting

This commit is contained in:
abejgonzalez
2019-05-27 15:29:09 -07:00
parent bc54b24b85
commit dde22a969b
25 changed files with 471 additions and 429 deletions

View File

@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# ReBAR documentation build configuration file, created by
# REBAR documentation build configuration file, created by
# sphinx-quickstart on Fri Mar 8 11:46:38 2019.
#
# This file is execfile()d with the current directory set to its
@@ -51,7 +51,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'ReBAR'
project = u'REBAR'
copyright = u'2019, Berkeley Architecture Research'
author = u'Berkeley Architecture Research'
@@ -124,7 +124,7 @@ html_sidebars = {
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'ReBARdoc'
htmlhelp_basename = 'REBARdoc'
# -- Options for LaTeX output ---------------------------------------------
@@ -151,7 +151,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'ReBAR.tex', u'ReBAR Documentation',
(master_doc, 'REBAR.tex', u'REBAR Documentation',
u'Berkeley Architecture Research', 'manual'),
]
@@ -161,7 +161,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'rebar', u'ReBAR Documentation',
(master_doc, 'rebar', u'REBAR Documentation',
[author], 1)
]
@@ -172,8 +172,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'ReBAR', u'ReBAR Documentation',
author, 'ReBAR', 'One line description of project.',
(master_doc, 'REBAR', u'REBAR Documentation',
author, 'REBAR', 'One line description of project.',
'Miscellaneous'),
]