Unverified Commit 2dc2ca8d authored by Lauren Adoram-Kershner's avatar Lauren Adoram-Kershner Committed by GitHub
Browse files

Setting up AutoCNet to interact with RTDs (#583) 

* adding RTD files

* dont build NBs and export ISISROOT to environment

* adding dummy ISISDATA env variable for kalasiris

* adding nbsphinx to environment and incorperating very bad work around to kalasiris import requirements

* addressing warnings

* adding workshops index.rst

* simplifying docs environment requirements and mocking models, reverting junky kalasiris workaround
parent b9b36dd1

.readthedocs.yaml

0 → 100644
+13 −0
Original line number Diff line number Diff line 
# .readthedocs.yaml

# Read the Docs configuration file

# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details



# Required

version: 2



# Build documentation in the docs/ directory with Sphinx

sphinx:

  configuration: docs/conf.py



conda:

  environment: docs/environment.yml

docs/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -180,3 +180,4 @@ pseudoxml: 
	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml

	@echo

	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/conf.py

+54 −0
Original line number Diff line number Diff line
@@ -45,6 +45,59 @@ sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) 


sys.path.insert(0, os.path.abspath('../'))



for mod_name in (

	"csmapi",

	"cv2",

	"dill",

	"geoalchemy2",

	"geoalchemy2.shape",

	"geopandas",

	"kalasiris",

	"knoten",

	"knoten.csm",

	"matplotlib",

	"matplotlib.pyplot",

	"numpy",

	"ogr",

	"osgeo",

	"pandas",

	"pandas.core",

	"pandas.core.indexing",

	"PIL",

	"plio",

	"plio.io",

	"plio.io.io_gdal",

	"plio.io.io_controlnetwork",

	"plio.io.isis_serial_number",

	"plio.utils",

	"plurmy",

	"psycopg2",

	"psycopg2.extensions",

	"pvl",

	"pyproj",

	"redis",

	"scipy",

	"scipy.spatial",

	"scipy.spatial.distance",

	"scipy.special",

	"scipy.stats",

	"scipy.ndimage",

	"scipy.ndimage.interpolation",

	"shapely",

	"shapely.affinity",

	"shapely.geometry",

	"shapely.ops",

	"shapely.wkt",

	"shapely.wkb",

	"skimage",

	"skimage.transform",

	"sklearn",

	"sklearn.cluster",

	"sklearn.neighbors",

	"sqlalchemy_utils",

	"yaml"

):

	sys.modules[mod_name]= MagicMock()

import autocnet



# -- General configuration ---------------------------------------------
@@ -52,6 +105,7 @@ import autocnet 
# If your documentation needs a minimal Sphinx version, state it here.

needs_sphinx = '1.3'

nbsphinx_allow_errors = True

nbsphinx_execute = 'never'



# Add any Sphinx extension module names here, as strings. They can be

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

docs/environment.yml

0 → 100644
+12 −0
Original line number Diff line number Diff line 
name: autocnet

channels:

  - conda-forge

  - default



dependencies:

  - cmake

  - nbsphinx

  - networkx

  - sphinx

  - sqlalchemy

  - yaml

docs/library/matcher/ciratefi.rst

+1 −1
Original line number Diff line number Diff line 
:mod:`matcher.ciratefi` --- RST-BC Invariant template match algorithm

====================================================================

=====================================================================



The :mod:`matcher.ciratefi` module