Skip to content

Commit

Permalink
Update API Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MJJoyce committed Feb 20, 2019
1 parent 0852674 commit 7fb34ea
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 15 deletions.
7 changes: 7 additions & 0 deletions doc/source/ait.dsn.sle.pdu.cltu.cltuv4.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ait.dsn.sle.pdu.cltu.cltuv4 module
==================================

.. automodule:: ait.dsn.sle.pdu.cltu.cltuv4
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/source/ait.dsn.sle.pdu.cltu.cltuv5.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ait.dsn.sle.pdu.cltu.cltuv5 module
==================================

.. automodule:: ait.dsn.sle.pdu.cltu.cltuv5
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/source/ait.dsn.sle.pdu.cltu.common.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ait.dsn.sle.pdu.cltu.common module
==================================

.. automodule:: ait.dsn.sle.pdu.cltu.common
:members:
:undoc-members:
:show-inheritance:
16 changes: 14 additions & 2 deletions doc/source/ait.dsn.sle.pdu.cltu.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
ait.dsn.sle.pdu.cltu module
===========================
ait.dsn.sle.pdu.cltu package
============================

Submodules
----------

.. toctree::

ait.dsn.sle.pdu.cltu.cltuv4
ait.dsn.sle.pdu.cltu.cltuv5
ait.dsn.sle.pdu.cltu.common

Module contents
---------------

.. automodule:: ait.dsn.sle.pdu.cltu
:members:
Expand Down
8 changes: 7 additions & 1 deletion doc/source/ait.dsn.sle.pdu.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
ait.dsn.sle.pdu package
=======================

Subpackages
-----------

.. toctree::

ait.dsn.sle.pdu.cltu

Submodules
----------

.. toctree::

ait.dsn.sle.pdu.binds
ait.dsn.sle.pdu.cltu
ait.dsn.sle.pdu.common
ait.dsn.sle.pdu.raf
ait.dsn.sle.pdu.rcf
Expand Down
24 changes: 12 additions & 12 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# BLISS SLE documentation build configuration file, created by
# AIT DSN documentation build configuration file, created by
# sphinx-quickstart on Fri Oct 20 10:25:50 2017.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -48,9 +48,9 @@
master_doc = 'index'

# General information about the project.
project = u'BLISS SLE'
copyright = u'2017, BLISS Development Team'
author = u'BLISS Development Team'
project = u'AIT DSN'
copyright = u'2017, AIT Development Team'
author = u'AIT Development 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
Expand Down Expand Up @@ -123,7 +123,7 @@

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#html_title = u'BLISS SLE v0.1.0'
#html_title = u'AIT DSN v0.1.0'

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
Expand Down Expand Up @@ -205,7 +205,7 @@
#html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'BLISSSLEdoc'
htmlhelp_basename = 'AITDSNdoc'

# -- Options for LaTeX output ---------------------------------------------

Expand All @@ -227,8 +227,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'BLISSSLE.tex', u'BLISS SLE Documentation',
u'BLISS Development Team', 'manual'),
(master_doc, 'AITDSN.tex', u'AIT DSN Documentation',
u'AIT Development Team', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -257,7 +257,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'blisssle', u'BLISS SLE Documentation',
(master_doc, 'aitsle', u'AIT DSN Documentation',
[author], 1)
]

Expand All @@ -271,8 +271,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'BLISSSLE', u'BLISS SLE Documentation',
author, 'BLISSSLE', 'One line description of project.',
(master_doc, 'AITDSN', u'AIT DSN Documentation',
author, 'AITDSN', 'One line description of project.',
'Miscellaneous'),
]

Expand All @@ -293,5 +293,5 @@
# intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {
'python': ('https://docs.python.org/2.7', None),
'bliss': ('https://github.jpl.nasa.gov/pages/bliss/bliss-core/', 'ait-core.inv')
'ait': ('https://github.com/NASA-AMMOS/AIT-Core', 'ait-core.inv')
}

0 comments on commit 7fb34ea

Please sign in to comment.