conf.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# pythreejs documentation build configuration file, created by
# sphinx-quickstart on Tue Apr  4 13:24:33 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# 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.


# -- 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.autodoc',
    'sphinx.ext.viewcode',
    'sphinx.ext.intersphinx',
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
    'autodoc_traits',
    'nbsphinx',
    'nbsphinx_link',
]

# Ensure our extension is available:
import sys
from os.path import dirname, join as pjoin
from sphinx.util import logging
logger = logging.getLogger(__name__)
docs = dirname(dirname(__file__))
root = dirname(docs)
sys.path.insert(0, root)
sys.path.insert(0, pjoin(docs, 'sphinxext'))

# 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 master toctree document.
master_doc = 'index'

# General information about the project.
project = 'pythreejs'
copyright = '2017, PyThreejs Development Team'
author = 'PyThreejs 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
# built documents.
#
# The short X.Y version.


# get version from nbdime:
import os
here = os.path.dirname(__file__)
repo = os.path.join(here, '..', '..')
_version_py = os.path.join(repo, 'pythreejs', '_version.py')
version_ns = {}
with open(_version_py) as f:
    exec(f.read(), version_ns)

# The short X.Y version.
version = '%i.%i' % version_ns['version_info'][:2]
# The full version, including alpha/beta/rc tags.
release = version_ns['__version__']

# 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

# 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 = ['**.ipynb_checkpoints']

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

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


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


# 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 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']


# -- Options for HTMLHelp output ------------------------------------------

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


# -- 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, 'pythreejs.tex', 'pythreejs Documentation',
     'PyThreejs Development Team', 'manual'),
]


# -- 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, 'pythreejs', 'pythreejs Documentation',
     [author], 1)
]


# -- 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, 'pythreejs', 'pythreejs Documentation',
     author, 'pythreejs', 'One line description of project.',
     'Miscellaneous'),
]


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/3/': None}

# Read The Docs
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from
# docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd:  # only import and set the theme if we're building docs locally
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# otherwise, readthedocs.org uses their theme by default, so no need to specify it


# Ignore anchored API links (javascript uses the anchors, otherwise invalid)
linkcheck_ignore = [r'https://threejs.org/docs/#(api|manual)']
# linkcheck_anchors_ignore = ['^!', '^api', '^manual']


nbsphinx_allow_errors = True # exception ipstruct.py ipython_genutils


def setup(app):
    if on_rtd and not os.path.exists(os.path.join(here, '_static', 'jupyter-threejs.js')):
        # We don't have a develop install on RTD, ensure we get autogen output:
        from subprocess import check_call
        popd = os.path.abspath(os.curdir)
        os.chdir(os.path.join(here, '..', '..', 'js'))
        try:
            check_call(['npm', 'install'])
            check_call(['npm', 'run', 'build:bundles-prod'])
        finally:
            os.chdir(popd)

    def add_scripts(app):
        for fname in ['jupyter-threejs.js']:
            if not os.path.exists(os.path.join(here, '_static', fname)):
                logger.warn('missing javascript file: %s' % fname)
            app.add_js_file(fname)

    def add_images(app):
        # TODO: Add all images automatically by dir
        for img_name in ('earth.jpg', 'checkerboard.png'):
            img = os.path.join('examples', 'img', img_name)
            app.builder.images[img] = img_name

    app.connect('builder-inited', add_scripts)

    if on_rtd:
        # Ensure example image resources are available. This requires a redirect on RTD.
        app.connect('builder-inited', add_images)