Browse Source

updated the docu

refactoring
sjunges 8 years ago
parent
commit
2ff400683a
  1. 0
      doc/source/code_doc.rst
  2. 12
      doc/source/code_stormpy_logic.rst
  3. 11
      doc/source/code_stormpy_storage.rst
  4. 3
      doc/source/conf.py
  5. 15
      doc/source/getting_started.rst
  6. 3
      doc/source/index.rst

0
doc/source/code_doc.rst

12
doc/source/code_stormpy_logic.rst

@ -0,0 +1,12 @@
Stormpy.logic
**************************
.. automodule:: stormpy
Members
=========================
.. automodule:: stormpy.logic.logic
:members:

11
doc/source/code_stormpy_storage.rst

@ -0,0 +1,11 @@
Stormpy.storage
**************************
.. automodule:: stormpy
Members
==============================
.. automodule:: stormpy.storage.storage
:members:

3
doc/source/conf.py

@ -84,6 +84,9 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = False
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------

15
doc/source/getting_started.rst

@ -3,8 +3,8 @@ Getting Started
**************************** ****************************
High-level API
======================
A Quick Tour through Stormpy
================================
We start with a selection of high-level constructs in stormpy. We start with a selection of high-level constructs in stormpy.
@ -24,17 +24,24 @@ Here, we build a Markov chain from a prism program.
Stormpy comes with a small set of examples, which we use here:: Stormpy comes with a small set of examples, which we use here::
import stormpy.examples import stormpy.examples
import stormpy.examples.files
With this, we can now import the path of our prism file:: With this, we can now import the path of our prism file::
path = stormpy.examples.knuth_yao
path = stormpy.examples.files.knuth_yao
prism_program = stormpy.parse_prism_program(path) prism_program = stormpy.parse_prism_program(path)
The `prism_program` can be translated into
The `prism_program` can be translated into Markov chains::
model = stormpy.build_model(program_program)
print("Number of states: {}".format(model.nr_states))
Building formulae
--------------------------
Checking properties
---------------------------

3
doc/source/index.rst

@ -23,7 +23,8 @@ Stormpy API Reference
:caption: Modules: :caption: Modules:
code_stormpy_core code_stormpy_core
code_stormpy_logic
code_stormpy_storage
Indices and tables Indices and tables

Loading…
Cancel
Save