mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
Python doc adjustments (#4756)
* Doc and adjustments of project.py * Doc and adjustments view.py * Python doc cleanup * Python : Add copy of files to deployment folder * Python : Several updates to doc * Python : Limit line lenghts * Minor adjustments
This commit is contained in:
39
ApplicationCode/GrpcInterface/Python/doc/make_and_copy.bat
Normal file
39
ApplicationCode/GrpcInterface/Python/doc/make_and_copy.bat
Normal file
@@ -0,0 +1,39 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
|
||||
REM Copy files to deployment folder using second parameter
|
||||
REM Example "d:\gitroot\ResInsight-UserDocumentation\content\scripting"
|
||||
xcopy /Y build\markdown %2
|
||||
@@ -10,70 +10,85 @@ This pages is created based on the content in the **PythonExamples** folder loca
|
||||
|
||||
|
||||
AllCases
|
||||
------
|
||||
--------
|
||||
.. literalinclude:: ../../rips/PythonExamples/AllCases.py
|
||||
|
||||
AppInfo
|
||||
------
|
||||
-------
|
||||
.. literalinclude:: ../../rips/PythonExamples/AppInfo.py
|
||||
|
||||
CaseGridGroup
|
||||
------
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/CaseGridGroup.py
|
||||
|
||||
CaseInfoStreamingExample
|
||||
------
|
||||
------------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/CaseInfoStreamingExample.py
|
||||
|
||||
CommandExample
|
||||
------
|
||||
--------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/CommandExample.py
|
||||
|
||||
ErrorHandling
|
||||
------
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/ErrorHandling.py
|
||||
|
||||
ExportSnapshots
|
||||
------
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/ExportSnapshots.py
|
||||
|
||||
GridInformation
|
||||
------
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/GridInformation.py
|
||||
|
||||
InputPropTestAsync
|
||||
------
|
||||
------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/InputPropTestAsync.py
|
||||
|
||||
InputPropTestSync
|
||||
------
|
||||
-----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/InputPropTestSync.py
|
||||
|
||||
InstanceExample
|
||||
------
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/InstanceExample.py
|
||||
|
||||
LaunchWithCommandLineOptions
|
||||
------
|
||||
----------------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/LaunchWithCommandLineOptions.py
|
||||
|
||||
SelectedCases
|
||||
------
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SelectedCases.py
|
||||
|
||||
SetCellResult
|
||||
------
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SetCellResult.py
|
||||
|
||||
SetFlowDiagnosticsResult
|
||||
------
|
||||
------------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SetFlowDiagnosticsResult.py
|
||||
|
||||
SetGridProperties
|
||||
------
|
||||
-----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SetGridProperties.py
|
||||
|
||||
SoilAverageAsync
|
||||
------
|
||||
----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SoilAverageAsync.py
|
||||
|
||||
SoilAverageSync
|
||||
------
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SoilAverageSync.py
|
||||
|
||||
SoilPorvAsync
|
||||
------
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SoilPorvAsync.py
|
||||
|
||||
SoilPorvSync
|
||||
------
|
||||
------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/SoilPorvSync.py
|
||||
|
||||
ViewExample
|
||||
------
|
||||
-----------
|
||||
.. literalinclude:: ../../rips/PythonExamples/ViewExample.py
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
Instance Module
|
||||
===============
|
||||
|
||||
.. autoclass:: rips.Instance
|
||||
.. autoclass:: rips.instance.Instance
|
||||
:members:
|
||||
|
||||
Example
|
||||
@@ -14,7 +14,7 @@ Example
|
||||
|
||||
Case Module
|
||||
===========
|
||||
.. autoclass:: rips.Case
|
||||
.. autoclass:: rips.case.Case
|
||||
:members:
|
||||
|
||||
Example
|
||||
@@ -25,23 +25,10 @@ Example
|
||||
:lines: 5-
|
||||
:emphasize-lines: 5
|
||||
|
||||
Commands Module
|
||||
===============
|
||||
|
||||
.. autoclass:: rips.Commands
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Example
|
||||
-------
|
||||
.. literalinclude:: ../../rips/PythonExamples/CommandExample.py
|
||||
:language: python
|
||||
:lines: 5-
|
||||
|
||||
Grid Module
|
||||
===========
|
||||
|
||||
.. autoclass:: rips.Grid
|
||||
.. autoclass:: rips.grid.Grid
|
||||
:members:
|
||||
|
||||
Example
|
||||
@@ -60,26 +47,21 @@ Example
|
||||
GridCaseGroup Module
|
||||
====================
|
||||
|
||||
.. autoclass:: rips.GridCaseGroup
|
||||
.. autoclass:: rips.gridcasegroup.GridCaseGroup
|
||||
:members:
|
||||
|
||||
|
||||
Project Module
|
||||
==============
|
||||
|
||||
.. autoclass:: rips.Project
|
||||
.. autoclass:: rips.project.Project
|
||||
:members:
|
||||
|
||||
Properties Module
|
||||
=================
|
||||
|
||||
.. autoclass:: rips.Properties
|
||||
:members:
|
||||
|
||||
View Module
|
||||
===========
|
||||
|
||||
.. autoclass:: rips.View
|
||||
.. autoclass:: rips.view.View
|
||||
:members:
|
||||
|
||||
Synchronous Example
|
||||
|
||||
Reference in New Issue
Block a user