Skip to content
Snippets Groups Projects
  • Brent Huisman's avatar
    Docs restructure for 0.4 (#1167) · 67b178cb
    Brent Huisman authored
    * Synced pages between Concepts, Python API and C++ API wherever possible
        * Recipe pages conform between the three section (concepts, python, c++)
        * Cell, Cable Cell and Cell * pages are rearranged and provided with some copy explaining the relationship between them.
    * Moved Python API out of Concepts
    * Renamed Concepts "How does Arbor work?"
    * Added Python Module Index plus mock import of Arbor for RTD build (unfortunately won't show there)
    * Broke out Interconnectivity (synapses) page.
    * Reworked Single Cell Model page into a quick start, with lots of cross referencing.
    * Tweaked logo.
    * Added Spack to install options.
    * Updated blurb.
    * Documentation now follows EU capitalization rules.
    * Assorted typofixes
    Unverified
    67b178cb
conf.py 1.52 KiB
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import sys, os

# Path to Python Binding (_arbor)
try:
    sys.path.append(os.path.join(os.environ['OLDPWD'],"python"))
    import arbor
except ImportError:
    autodoc_mock_imports = ['arbor._arbor']

html_static_path = ['static']

def setup(app):
    app.add_css_file('custom.css')
    app.add_object_type('generic', 'gen', 'pair: %s; generic')
    app.add_object_type('label', 'lab', 'pair: %s; label')

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.coverage'
]
source_suffix = '.rst'
master_doc = 'index'

html_logo = 'images/arbor-lines-proto-colour.svg'
html_favicon = 'images/arbor-lines-proto-colour-notext.svg'

project = 'Arbor'
copyright = '2017, ETHZ & FZ Julich'
author = 'ETHZ & FZ Julich'
todo_include_todos = True

html_theme = "sphinx_rtd_theme"
html_theme_options = {
    'logo_only': True,
    'style_nav_header_background': '#dfdcdf'}

# This style makes the source code pop out a bit more
# from the background text, without being overpowering.
pygments_style = 'perldoc'

# Generate images for the documentation.
print("--- generating images ---")

# Location of scripts used to generate images
this_path=os.path.split(os.path.abspath(__file__))[0]
script_path=this_path+'/scripts'
sys.path.append(script_path)
import make_images

# Output path for generated images
img_path=this_path+'/gen-images'
if not os.path.exists(img_path):
    os.mkdir(img_path)

make_images.generate(img_path)

print("-------------------------")