update docs

CSUFTitanRover · Oct 28, 2017 · 5dc17df · 5dc17df
1 parent 3071dec
commit 5dc17df
Show file tree

Hide file tree

Showing 10 changed files with 66 additions and 119 deletions.
diff --git a/docs/.vscode/settings.json b/docs/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+  // restructuredtext settings
+  "restructuredtext.builtDocumentationPath": "${workspaceRoot}/build/html/",
+  "restructuredtext.confPath": "${workspaceRoot}/source/"
+}
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
-SPHINXPROJ    = TitanRover2018
+SPHINXPROJ    = TitanRover
 SOURCEDIR     = source
 BUILDDIR      = build
 

diff --git a/docs/i2c Python - Arduino Example/i2c.py b/docs/i2c Python - Arduino Example/i2c.py
diff --git a/docs/i2c Python - Arduino Example/i2c_Slave_Arduino/i2c_Slave_Arduino.ino b/docs/i2c Python - Arduino Example/i2c_Slave_Arduino/i2c_Slave_Arduino.ino
diff --git a/docs/make.bat b/docs/make.bat
@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=source
 set BUILDDIR=build
-set SPHINXPROJ=TitanRover2018
+set SPHINXPROJ=TitanRover
 
 if "%1" == "" goto help
 

diff --git a/docs/requirements.backup.txt b/docs/requirements.backup.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# Titan Rover 2018 documentation build configuration file, created by
-# sphinx-quickstart on Wed Sep 20 17:34:31 2017.
+# Titan Rover documentation build configuration file, created by
+# sphinx-quickstart on Fri Oct 27 22:13:09 2017.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -21,6 +21,7 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 import sphinx_rtd_theme
+from recommonmark.parser import CommonMarkParser
 
 # -- General configuration ------------------------------------------------
 
@@ -32,24 +33,29 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
-    'sphinx.ext.mathjax']
+    'sphinx.ext.mathjax',
+    'sphinx.ext.githubpages']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+# add parser support for Markdown files
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = 'Titan Rover 2018'
-copyright = '2017, Michael Negrete, Timothy Parks, Richard Stanley, Richard Erdtsieck'
-author = 'Michael Negrete, Timothy Parks, Richard Stanley, Richard Erdtsieck'
+project = 'Titan Rover'
+copyright = '2017, Controls Team'
+author = 'Controls Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -85,6 +91,7 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # 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
@@ -95,7 +102,7 @@
 # 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 = [sphinx_rtd_theme.get_html_theme_path()]
+html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -116,7 +123,7 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'TitanRover2018doc'
+htmlhelp_basename = 'TitanRoverdoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -143,8 +150,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'TitanRover2018.tex', 'Titan Rover 2018 Documentation',
-     'Michael Negrete, Timothy Parks, Richard Stanley, Richard Erdtsieck', 'manual'),
+    (master_doc, 'TitanRover.tex', 'Titan Rover Documentation',
+     'Controls Team', 'manual'),
 ]
 
 
@@ -153,7 +160,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'titanrover2018', 'Titan Rover 2018 Documentation',
+    (master_doc, 'titanrover', 'Titan Rover Documentation',
      [author], 1)
 ]
 
@@ -164,10 +171,31 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'TitanRover2018', 'Titan Rover 2018 Documentation',
-     author, 'TitanRover2018', 'One line description of project.',
+    (master_doc, 'TitanRover', 'Titan Rover Documentation',
+     author, 'TitanRover', 'One line description of project.',
      'Miscellaneous'),
 ]
 
 
 
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,15 +1,21 @@
-.. Titan Rover 2018 documentation master file, created by
-   sphinx-quickstart on Wed Sep 20 17:34:31 2017.
+.. Titan Rover documentation master file, created by
+   sphinx-quickstart on Fri Oct 27 22:13:09 2017.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Titan Rover 2018's documentation!
-============================================
+Welcome to Titan Rover's documentation!
+=======================================
 
-.. toctree::
-   :maxdepth: 2
+Titan Rover is a collaboration of multi-disciplinary students who gather together to 
+research, design, manufacture, and test a Mars Exploration Rover (MER) on behalf of
+Cal State Fullerton at the University Rover Challenge (URC). The rover is built from
+the ground up using in-house materials and is completely designed by team members of Titan Rover
 
-    user-interface
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  user-interface
 
 
 Indices and tables

diff --git a/docs/source/user-interface.rst b/docs/source/user-interface.rst
@@ -1,4 +1,5 @@
 User Interface
 ==============
 
-This year's user interface will be a real-time data driven web application.
+The user interface is a real-time data driven web application.
+It provides the team with real-time updates of sensors, data, and camera feeds to monitor the rover.