Configuration for Sphinx

docs/source/PythonExamples.rst

@@ -0,0 +1,159 @@
+Python Examples
+---------------
+
+This pages is created based on the content in the **PythonExamples** folder located inside the **rips** module, made available online for convenience.
+
+========
+AllCases
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/all_cases.py
+
+==================
+AllSimulationWells  
+==================
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/all_simulation_wells.py
+
+========
+AllWells
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/all_wells.py
+
+========
+AlterWbsPlot
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/alter_wbs_plot.py 
+
+========
+CaseGridGroup
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/case_grid_group.py
+
+========
+CaseInfoStreamingExample
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/case_info_streaming_example.py
+
+========
+CellResultData
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/cell_result_data.py
+
+========
+CommandExample
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/command_example.py
+
+========
+Create WBS Plot
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/create_wbs_plot.py
+
+========
+ErrorHandling
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/error_handling.py
+
+========
+ExportContourMaps
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/export_contour_maps.py 
+
+========
+ExportPlots
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/export_plots.py
+
+========
+ExportSnapshots
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/export_snapshots.py
+
+========
+GridInformation
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/grid_information.py
+
+========
+Import Well Paths
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/import_well_paths_and_logs.py
+
+========
+InputPropTestAsync
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/input_prop_test_async.py
+
+========
+InputPropTestSync
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/input_prop_test_sync.py
+
+========
+InstanceExample
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/instance_example.py
+
+========
+LaunchWithCommandLineOptions
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/launch_with_commandline_options.py
+
+========
+Launch Using Command Line Options
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/launch_with_commandline_options.py
+
+========
+NewSummaryPlot
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/new_summary_plot.py
+
+========
+SelectedCases
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/selected_cases.py
+
+========
+SelectedCells
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/selected_cells.py
+
+========
+SetCellResult
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/set_cell_result.py
+
+========
+SetFlowDiagnosticsResult
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/set_flow_diagnostics_result.py
+
+========
+SetGridProperties
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/set_grid_properties.py
+
+========
+SoilAverageAsync
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_average_async.py
+
+========
+SoilAverageSync
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_average_sync.py
+
+========
+SoilPorvAsync
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_porv_async.py
+
+========
+SoilPorvSync
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_porv_sync.py
+
+========
+ViewExample
+========
+.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/view_example.py

docs/source/conf.py

@@ -0,0 +1,73 @@
+# 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:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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('..'))
+# TODO: We need to get access to the generated files in /ApplicationCode/GrpcInterface/Python/rips/generated
+# It is not clear how we can organize these files for readthedocs
+# sys.path.insert(0, os.path.abspath('../../ApplicationCode/GrpcInterface/Python'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'ResInsight Scripting API'
+copyright = '2020, Ceetron Solutions AS'
+author = 'Ceetron Solutions AS'
+
+# The full version, including alpha/beta/rc tags
+release = '2020.04'
+
+
+# -- 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 = [
+    'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon'
+]
+
+master_doc  = 'index'
+
+napoleon_google_docstring = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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/*']
+
+
+# -- 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 = "sphinx_rtd_theme"
+
+html_logo = "images/ResInsightCroppedIconPicture.png"
+
+html_theme_options = {
+    'style_nav_header_background': '#505050',
+}
+smartquotes=False
+
+# 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']
+
+
+# -- Extension configuration -------------------------------------------------

docs/source/index.rst

@@ -0,0 +1,23 @@
+ResInsight Scripting API
+========================
+
+Many features of ResInsigt can automated using the Python API
+
+See https://resinsight.org for the main **ResInsight** documentation.
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 1
+
+   PythonExamples
+   rips
+   pdm_objects
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/pdm_objects.rst

@@ -0,0 +1,13 @@
+pdm\_objects module
+===================
+
+This module contains the classes used to wrap the autogenerated classes from **GRPC**. Usually, the 
+script writer does not have to look here, but the documentation is included for completeness.
+
+.. automodule:: rips.generated.pdm_objects
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
+.. autoattribute:: rips.generated.pdm_objects

docs/source/rips.rst

@@ -0,0 +1,92 @@
+rips package
+============
+
+rips.case module
+----------------
+
+.. automodule:: rips.case
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.contour\_map module
+------------------------
+
+.. automodule:: rips.contour_map
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.grid module
+----------------
+
+.. automodule:: rips.grid
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.gridcasegroup module
+-------------------------
+
+.. automodule:: rips.gridcasegroup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.instance module
+--------------------
+
+.. automodule:: rips.instance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.pdmobject module
+---------------------
+
+.. automodule:: rips.pdmobject
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.plot module
+----------------
+
+.. automodule:: rips.plot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.project module
+-------------------
+
+.. automodule:: rips.project
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.simulation\_well module
+----------------------------
+
+.. automodule:: rips.simulation_well
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.view module
+----------------
+
+.. automodule:: rips.view
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rips.well\_log\_plot module
+---------------------------
+
+.. automodule:: rips.well_log_plot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+