Skip to content

Commit

Permalink
added links to abaco docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eriksf committed Jul 10, 2018
1 parent 8118ef2 commit 74c6653
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 8 deletions.
16 changes: 14 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
# 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 os
# import sys
from recommonmark.parser import CommonMarkParser
# sys.path.insert(0, os.path.abspath('.'))

# -- RTD configuration -------------------------------------------------------
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

# -- Project information -----------------------------------------------------

Expand Down Expand Up @@ -83,6 +85,12 @@
# a list of builtin themes.
#
html_theme = 'default'
if not on_rtd:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
else:
html_theme = 'default'

# 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
Expand Down Expand Up @@ -168,7 +176,11 @@
# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {
'python': ('https://docs.python.org/', None),
'abaco': ('https://abaco.readthedocs.io/en/latest/', None),
'agave': ('https://agave.readthedocs.io/en/latest/', None)
}

# -- Options for todo extension ----------------------------------------------

Expand Down
14 changes: 8 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,23 @@ TACC Cloud APIs

The TACC Cloud APIs include Agave API, offering Science-as-a-Service; Reactors, which are functions-as-a-service adapted to the HPC use case; and TAS, the TACC Allocation System which handles identity and allocations.

.. toctree::
:maxdepth: 2
:caption: API Reference

Abaco <https://tacc-cloud.readthedocs.io/projects/abaco/en/latest/>
Agave <https://tacc-cloud.readthedocs.io/projects/agave/en/latest/>

Get Help
--------

Additional information and training resources are available at the `TACC User Portal <https://portal.tacc.utexas.edu/>`_ and the `TACC Learning Center <https://learn.tacc.utexas.edu/>`_.

You can also e-mail *help-at-tacc-dot-utexas-dot-edu*.

.. toctree::
:maxdepth: 2
:caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
sphinx
sphinx-rtd-theme
sphinx-fontawesome
recommonmark

0 comments on commit 74c6653

Please sign in to comment.