conf.py

# -*- coding: utf-8 -*-
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import sphinx_rtd_theme
import subprocess

#
# The SAF documentation is embedded in the sources as originally made possible by Robb
# Matzke's `mkdoc` tool. That means the .rst files don't actually exist in the repo and
# are instead generated using mkdoc. The logic here mimics logic in SAF's Makefiles to
# implement 'make refman.rest' by listing the source files and then issuing calls to
# mkdoc to produce the .rst files from the sources. In addition, we need to generate
# several of SSlib data types used using the `sstypegen` tool. We run that first
# followed by 3 invokations of `mkdoc` for SSlib, SAF library and SAF examples. In
# addition to making this work for RTD, this also means just running `sphinx-build`
# from the top-level directory will generate sphinx documentation without requiring
# the library to be configured. 
#
SSLIB_PRIV_HDR = ""

SSLIB_PUB_HDR = "sslib.h sserr.h ssprop.h ssstring.h ssarray.h ssobj.h sstable.h sspers.h \
ssscope.h ssfile.h ssval.h ssblob.h ssmpi.h sshdf5.h ssenv.h ssvers.h ssgfile.h ssattr.h \
ssaio.h ssperstab.h ssscopetab.h ssfiletab.h ssblobtab.h ssattrtab.h sslinks.h ssdebug.h"

SSLIB_LIB_SRC = "sslib.c sserr.c ssprop.c ssstring.c ssarray.c ssobj.c sstable.c sspers.c \
ssperstab.c ssscope.c ssscopetab.c ssfile.c ssfiletab.c ssval.c ssblob.c ssblobtab.c sshdf5.c \
ssmpi.c ssgfile.c ssattr.c ssattrtab.c ssaio.c ssdebug.c"

SSLIB_SRC = "%s %s %s"%(SSLIB_LIB_SRC, SSLIB_PUB_HDR, SSLIB_PRIV_HDR)

GEN_SOURCE = "ssblob.h sspers.h ssscope.h ssfile.h ssattr.h"

# generate types and version file 
curdir = os.getcwd()
os.chdir('./src/sslib/lib')
args = ['../tools/sstypegen']
args +=  GEN_SOURCE.split(' ')
subprocess.call(args)
os.chdir(curdir)

# run mkdoc on sslib library
args = ['./tools/mkdoc',
    '-c', './src/sslib/docs/mkdoc/SSlib-API.mkdoc',
    '-o', './docs/sslib_refman.rest',
    '-f', 'rest',
    '-m',
    '-p', './src/sslib/lib']
args +=  SSLIB_SRC.split(' ')
subprocess.call(args)

SAF_PUB_HDR = "saf.h SAFdb.h SAFdbprops.h SAFinfo.h SAFinit.h SAFlibprops.h SAFquant.h \
SAFunit.h SAFrole.h SAFbasis.h SAFalgebraic.h SAFevaluation.h SAFrelrep.h"

SAF_PRIV_HDR = "algebraic.h basis.h db.h dbprops.h evaluation.h libprops.h quant.h relrep.h \
safP.h unit.h wrapper.h genreg.h hash.h"

SAF_LIB_SRC = "error.c libprops.c dbprops.c fileprops.c info.c init.c db.c utils.c role.c \
basis.c quant.c unit.c algebraic.c evaluation.c relrep.c cat.c coll.c genreg.c field.c rel.c \
ftempl.c altindx.c suite.c stempl.c state.c set.c hash.c"

SAF_SRC = "%s %s %s"%(SAF_LIB_SRC, SAF_PUB_HDR, SAF_PRIV_HDR)

# run mkdoc on saf library
args = ['./tools/mkdoc',
    '-c', './tools/Formats/library/META',
    '-o', './docs/safapi_refman.rest',
    '-f', 'rest',
    '-m',
    '-p', './src/safapi/lib',
    '-x', './docs/sslib_refman.rest']
args +=  SAF_SRC.split(' ')
subprocess.call(args)

SAFEX_PUB_HDR = ""

SAFEX_PRIV_HDR = ""

SAFEX_LIB_SRC = "larry1w.c exo_par_wt.c exo_basic_wt.c dyn_lb.c triangle_mesh.c storagew.c \
birth_death_w.c birth_death_r.c exo_basic_rd.c hadaptive.c loadbalance.c loadbalance_rd.c \
remap_n21.c exo_par_rd.c dyn_lb_rd.c exampleutil.c exampleutil.h"

SAFEX_SRC = "%s %s %s"%(SAFEX_LIB_SRC, SAFEX_PUB_HDR, SAFEX_PRIV_HDR)

# run mkdoc on saf examples
args = ['./tools/mkdoc',
    '-c', './tools/Formats/example/META', 
    '-o', './docs/safexamples_refman.rest',
    '-f', 'rest',
    '-m',
    '-p', './src/safapi/examples',
    '-x', './docs/safapi_refman.rest']
args +=  SAFEX_SRC.split(' ')
subprocess.call(args)

# make top-level index.rst
f = open('index.rst','w')
f.write('SAF Software\n')
f.write('############\n')
f.write('SAF Software is `available on github <https://github.com/markcmiller86/SAF>`_\n\n')
f.write('SAF User Manuals\n')
f.write('################\n\n')
f.write('.. toctree::\n\n')
f.write('   Sets and Fields (SAF) API <docs/safapi_refman.rest/index>\n')
f.write('   SAF Examples <docs/safexamples_refman.rest/index>\n')
f.write('   SAF Support Library <docs/sslib_refman.rest/index>\n')
f.close()

# Some pre-liminary work to detect if we're running a spell check
BuilderIsSpelling = False
if '-b' in sys.argv and 'spelling' in sys.argv:
    if sys.argv.index('-b') == sys.argv.index('spelling')-1:
        BuilderIsSpelling = True

# If extensions (or modules to document with autodoc) are in another directory,
# 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.
#sys.path.insert(0, os.path.abspath('.'))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.mathjax']
if BuilderIsSpelling:
    extensions += ['sphinxcontrib.spelling']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'SAF User Manual'
copyright = """
2005-07-01, Sandia proj 28462, 002008MLTPL00, OSTI: 1230929.
This documentation was automatically generated via Robb Matzke's Mkdoc
"""
author = u'SNL'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'2.0.3'
# The full version, including alpha/beta/rc tags.
release = u'2.0.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

numfig = True

# Best place to put a substitution for 'VisIt'
# Authors should use either VisIt_ or VisIt_'s
rst_epilog = """
.. _SAF: https://github.com/markcmiller86/SAF
"""

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'

# 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
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#html_title = u'VisIt User Manual v2.11'

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (relative to this directory) to use as a favicon of
# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# 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 = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []

# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#html_last_updated_fmt = None

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'

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

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

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',

# Latex figure (float) alignment
#'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'SAFUseManual.tex', u'SAF User Manual',
     u'LLNL', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'foo', u'SAF User Manual Documentation',
     [author], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'Foo', u'SAF User Manual Documentation',
     author, 'Foo', 'One line description of project.',
     'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

#
# NO-OP the .. spelling:: directive for normal use.
# Do NOT add the NO-OP directive if this is a spell check build
#
def setup(app):
    if not BuilderIsSpelling:
        app.add_directive('spelling', SpellingDirective)

#
# A custom directive to NO-OP .. spelling::
#
from docutils.parsers.rst import Directive

class SpellingDirective(Directive):

    has_content = True

    def run(self):
        return []