Commit 7ba67230 authored by Stefan Scherfke's avatar Stefan Scherfke

Improved and fixed the core API docs.

parent cd531da3
......@@ -2,19 +2,19 @@
``simpy.core`` --- SimPy's core components
==========================================
.. automodule:: simpy.core
Environments
============
.. autoclass:: BaseEnvironment
:members:
.. autoclass:: Environment
:members:
:show-inheritance:
:inherited-members:
.. autoclass:: BaseEnvironment
:members:
Events
======
......@@ -24,52 +24,36 @@ Events
.. autoclass:: Process
:members:
:show-inheritance:
.. autoclass:: Timeout
:members:
:show-inheritance:
.. autoclass:: Condition
:members:
:show-inheritance:
.. autoclass:: Initialize
:members:
:show-inheritance:
.. autoclass:: AllOf
:members:
:show-inheritance:
.. autoclass:: AnyOf
:members:
:show-inheritance:
.. autoclass:: Initialize
:members:
Miscellaneous (Interrupt and constants)
=======================================
.. autoclass:: BoundClass
:members:
.. autoclass:: EmptySchedule
.. autoclass:: Interrupt
:members: cause
.. data:: Infinity = inf
Convenience alias for infinity
.. data:: PENDING = object()
Unique object to identify pending values of events
.. data:: HIGH_PRIORITY = 0
Priority of interrupts and Intialize events
.. data:: DEFAULT_PRIORITY = 1
Default priority used by events
.. data:: LOW_PRIORITY = 2
Priority of timeouts
.. autodata:: Infinity
.. autodata:: PENDING
.. autodata:: HIGH_PRIORITY
.. autodata:: DEFAULT_PRIORITY
.. autodata:: LOW_PRIORITY
==============================
``simpy`` --- The user API
``simpy`` --- The end user API
==============================
.. automodule:: simpy
......@@ -3,5 +3,4 @@ SimPy home
==========
..
_templates/index.html contains the content for this page.
.. _templates/index.html contains the content for this page.
"""
The ``simpy`` module provides SimPy's end-user API. It therefore
aggregates Simpy's various classes and methods:
The ``simpy`` module provides SimPy's end-user API. It aggregates Simpy's most
important classes and methods. This is purely for your convenience. You can of
course also access everything (and more!) via their actual submodules.
Core classes and functions
......@@ -11,7 +12,7 @@ Core classes and functions
- :class:`Environment`: SimPy's central class. It contains
the simulation's state and lets the PEMs interact with it (i.e.,
schedule events).
- :class:`Process`: This class represents a PEM while
- :class:`Process`: This class represents a process function while
it is executed in an environment. An instance of it is returned by
:meth:`Environment.start()`. It inherits :class:`Event`.
- :class:`Interrupt`: This exception is thrown into a process if it gets
......
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment