A start on docs for VUI.
It's hella crude yet.
This commit is contained in:
@@ -12,9 +12,9 @@
|
||||
# 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('.'))
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('../../..'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
@@ -69,7 +69,7 @@ language = None
|
||||
exclude_patterns = []
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = None
|
||||
pygments_style = 'colorful'
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
@@ -6,11 +6,32 @@
|
||||
Welcome to Joy VUI's documentation!
|
||||
===================================
|
||||
|
||||
.. image:: _static/Joy-VUI-screenshot.PNG
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
|
||||
.. automodule:: joy.vui.core
|
||||
:members:
|
||||
|
||||
|
||||
.. automodule:: joy.vui.display
|
||||
:members:
|
||||
|
||||
|
||||
.. automodule:: joy.vui.viewer
|
||||
:members:
|
||||
|
||||
|
||||
.. automodule:: joy.vui.text_viewer
|
||||
:members:
|
||||
|
||||
|
||||
.. automodule:: joy.vui.stack_viewer
|
||||
:members:
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
Reference in New Issue
Block a user