Skip to content
Snippets Groups Projects
Select Git revision
  • 8a9482c35a1c57f879209c75d5130c3ae866965e
  • main default protected
  • Kelvinrr-patch-3
  • radius_update
  • revert-616-apollo_pan
  • vims
  • 0.10
  • Kelvinrr-patch-2
  • revert-563-minirf_fix
  • Kelvinrr-patch-1
  • 0.9
  • acpaquette-patch-3
  • acpaquette-patch-2
  • acpaquette-patch-1
  • spiceql
  • ci-coverage
  • 0.10.0
  • 0.9.1
  • 0.9.0
  • 0.8.7
  • 0.8.8
  • 0.8.6
  • 0.8.3
  • 0.8.4
  • 0.8.5
  • 0.8.2
  • 0.8.1
  • 0.8.0
  • 0.7.3
  • 0.7.2
  • 0.7.1
  • 0.7.0
  • 0.6.5
  • 0.6.4
  • 0.6.3
  • 0.6.2
36 results

conf.py

Blame
    • Lauren Adoram-Kershner's avatar
      8a9482c3
      Doc badge (#405) · 8a9482c3
      Lauren Adoram-Kershner authored
      * initial commit
      
      * updating master doc
      
      * reorganizing landing page
      
      * heckin mv everything up a dir
      
      * forgot to switch main index file
      
      * firing off doxygen build before RTD
      8a9482c3
      History
      Doc badge (#405)
      Lauren Adoram-Kershner authored
      * initial commit
      
      * updating master doc
      
      * reorganizing landing page
      
      * heckin mv everything up a dir
      
      * forgot to switch main index file
      
      * firing off doxygen build before RTD
    conf.py 2.26 KiB
    # Configuration file for the Sphinx documentation builder.
    #
    # This file only contains a selection of the most common options. For a full
    # list see the documentation:
    # https://www.sphinx-doc.org/en/master/usage/configuration.html
    
    # -- Path setup --------------------------------------------------------------
    
    # 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.
    #
    # import os
    # import sys
    # sys.path.insert(0, os.path.abspath('.'))
    
    
    # -- Project information -----------------------------------------------------
    
    project = 'Abstraction Layer for Ephemerides (ALE)'
    copyright = '2021, USGS-Astrogeology Science Center'
    author = 'USGS-Astrogeology Science Center'
    
    # The full version, including alpha/beta/rc tags
    release = 'ale.__version__'
    
    
    # -- General configuration ---------------------------------------------------
    
    # Add any Sphinx extension module names here, as strings. They can be
    # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
    # ones.
    extensions = [
    ]
    
    # Add any paths that contain templates here, relative to this directory.
    templates_path = ['_templates']
    
    # The master toctree document.
    master_doc = 'index'
    
    # List of patterns, relative to source directory, that match files and
    # directories to ignore when looking for source files.
    # This pattern also affects html_static_path and html_extra_path.
    exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
    
    
    # -- 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 = 'alabaster'
    
    # 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']
    
    # -- Run Doxygen for C++ API --------------------------------------------------
    import subprocess, os
    
    read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
    
    if read_the_docs_build:
        subprocess.call('cd ../doxygen; doxygen', shell=True)