dev-guide/contributing
dev-guide/repo-structure
dev-guide/templates
dev-guide/snippets/index
dev-guide/resources
"""
# Automatically generate documentaion pages
Generator().DocumentPackages(
[PVGeo, pvmacros],
index_base='../index_base.rst',
showprivate=True,
notify=False,
intro_pages=[
'overview/why-pvgeo',
'overview/getting-started',
'overview/featured',
'overview/agu-2018',
],
append_material=append_material,
extra=extra,
)
import pyvista
import numpy as np
# Manage errors
pyvista.set_error_output_file('errors.txt')
# Ensure that offscreen rendering is used for docs generation
pyvista.OFF_SCREEN = True # Not necessary - simply an insurance policy
pyvista.BUILDING_GALLERY = True # necessary when building the sphinx gallery
# Preferred plotting style for documentation
# -- 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('../..'))
sys.path.insert(0, '/Users/bane/Documents/OpenGeoVis/Software/gendocs/')
# Import the package to document:
import wtools
# Automatically generate documentation pages
from gendocs import Generator
Generator().DocumentPackages(wtools,
index_base='../../README.rst',
showinh=False)
# -- Project information -----------------------------------------------------
project = 'wtools'
copyright = '2018, Bane Sullivan'
author = 'Bane Sullivan'
# The short X.Y version
version = '0.0.4'
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# 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('../..'))
sys.path.insert(0, '/Users/bane/Documents/OpenGeoVis/Software/gendocs/')
# Import the package to document:
import pvgeohdf
# Automatically generate documentation pages
from gendocs import Generator
Generator().DocumentPackages(pvgeohdf,
index_base='../../README.rst',
showprivate=True)
# -- Project information -----------------------------------------------------
project = 'PVGeo-HDF5'
copyright = '2018, Bane Sullivan'
author = 'Bane Sullivan'
# The short X.Y version
version = '0.1.0'
# The full version, including alpha/beta/rc tags
release = ''
# -- General configuration ---------------------------------------------------
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
path = os.path.abspath('../..')
sys.path.insert(0, path)
# -- Automatic Doc Pages Generation ------------------------------------------
import vtkplotter # for documenting
from gendocs import Generator
# Automatically generate documentaion pages
Generator().DocumentPackages(
[vtkplotter],
'../README.rst',
showprivate=False,
notify=False,
)
# -- Project information -----------------------------------------------------
project = 'vtkplotter'
copyright = '2019, M. Musy & G. Dalmasso'
author = 'Marco Musy'
# The short X.Y version
version = '8.9.1'
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
MOCK_MODULES = ['paraview', 'paraview.simple']
for mod_name in MOCK_MODULES:
sys.modules[mod_name] = mock.Mock()
autodoc_mock_imports = ['paraview']
# # Automattically generat source pages:
# os.system('python ./make_files.py')
import PVGeo, pvmacros # for documenting
from gendocs import Generator
# Automatically generate documentaion pages
Generator().DocumentPackages([PVGeo, pvmacros],
index_base='../index_base.rst',
showprivate=True,
notify=False,
)
# -- Project information -----------------------------------------------------
project = 'PVGeo'
copyright = u'2018, Bane Sullivan, http:://banesullivan.com'
author = 'Bane Sullivan'
html_show_copyright = False
html_show_sphinx = False
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
path = os.path.abspath('../..')
sys.path.insert(0, path)
# -- Automatic Doc Pages Generation ------------------------------------------
import omfvtk # for documenting
from gendocs import Generator
# Automatically generate documentaion pages
Generator().DocumentPackages(
[omfvtk],
'../../README.rst',
showprivate=True,
notify=False,
)
# -- Project information -----------------------------------------------------
project = 'omfvtk'
copyright = '2019, Bane Sullivan'
author = 'Bane Sullivan'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.0.0'
# -- General configuration ---------------------------------------------------
append_material = """
.. toctree::
:maxdepth: 2
:caption: Examples
:hidden:
examples/index
"""
# Automatically generate documentaion pages
Generator().DocumentPackages(
[omfvista],
'../../README.rst',
showprivate=True,
notify=False,
append_material=append_material,
)
# -- Project information -----------------------------------------------------
project = 'omfvista'
copyright = '2019, Bane Sullivan'
author = 'Bane Sullivan'
# The short X.Y version
version = omfvista.__version__
# The full version, including alpha/beta/rc tags
release = omfvista.__version__
# 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
path = os.path.abspath('../..')
sys.path.insert(0, path)
# -- Automatic Doc Pages Generation ------------------------------------------
import gendocs # for documenting
from gendocs import Generator
# Automatically generate documentaion pages
Generator().DocumentPackages([gendocs],
'../../README.rst',
showprivate=True,
notify=False)
# -- Project information -----------------------------------------------------
project = 'gendocs'
copyright = u'2018, Bane Sullivan, http:://banesullivan.com'
author = 'Bane Sullivan'
html_show_copyright = False
html_show_sphinx = False
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.0.2'
# -- 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('../..'))
# Import the package to document:
import espatools
# Automatically generate documentation pages
from gendocs import Generator
Generator().DocumentPackages(espatools, index_base='../../README.rst', notify=False)
# -- Project information -----------------------------------------------------
project = 'espatools'
copyright = u'2018, Bane Sullivan, http:://banesullivan.com'
author = 'Bane Sullivan'
html_show_copyright = False
html_show_sphinx = False
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = 'v0.0.2'