Skip to content

Commit

Permalink
start using api doc styles
Browse files Browse the repository at this point in the history
  • Loading branch information
loechel committed Mar 2, 2017
1 parent d259149 commit 69d7878
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 6 deletions.
96 changes: 91 additions & 5 deletions docs/usage/api.rst
Expand Up @@ -5,11 +5,97 @@ RestrictedPython has tree major scopes:

1. ``compile_restricted`` methods:

* ``compile_restricted``
* ``compile_restricted_exec``
* ``compile_restricted_eval``
* ``compile_restricted_single``
* ``compile_restricted_function``
.. py:method:: compile_restricted(source, filename, mode, flags, dont_inherit, policy)
:module: RestrictedPython

Compiles source code into interpretable byte code.

:param source: (required). The source code that should be compiled
:param filename: (optional).
:param mode: (optional).
:param flags: (optional).
:param dont_inherit: (optional).
:param policy: (optional).
:type source: str or unicode text
:type filename: str or unicode text
:type mode: str or unicode text
:type flags: int
:type dont_inherit: int
:type policy: RestrictingNodeTransformer class
:return: Byte Code

.. py:method:: compile_restricted_exec(source, filename, flags, dont_inherit, policy)
:module: RestrictedPython

Compiles source code into interpretable byte code.

:param source: (required). The source code that should be compiled
:param filename: (optional).
:param flags: (optional).
:param dont_inherit: (optional).
:param policy: (optional).
:type source: str or unicode text
:type filename: str or unicode text
:type mode: str or unicode text
:type flags: int
:type dont_inherit: int
:type policy: RestrictingNodeTransformer class
:return: CompileResult (a namedtuple with code, errors, warnings, used_names)

.. py:method:: compile_restricted_eval(source, filename, flags, dont_inherit, policy)
:module: RestrictedPython

Compiles source code into interpretable byte code.

:param source: (required). The source code that should be compiled
:param filename: (optional).
:param flags: (optional).
:param dont_inherit: (optional).
:param policy: (optional).
:type source: str or unicode text
:type filename: str or unicode text
:type mode: str or unicode text
:type flags: int
:type dont_inherit: int
:type policy: RestrictingNodeTransformer class
:return: CompileResult (a namedtuple with code, errors, warnings, used_names)

.. py:method:: compile_restricted_single(source, filename, flags, dont_inherit, policy)
:module: RestrictedPython

Compiles source code into interpretable byte code.

:param source: (required). The source code that should be compiled
:param filename: (optional).
:param flags: (optional).
:param dont_inherit: (optional).
:param policy: (optional).
:type source: str or unicode text
:type filename: str or unicode text
:type mode: str or unicode text
:type flags: int
:type dont_inherit: int
:type policy: RestrictingNodeTransformer class
:return: CompileResult (a namedtuple with code, errors, warnings, used_names)

.. py:method:: compile_restricted_function(p, body, name, filename, globalize=None)
:module: RestrictedPython

Compiles source code into interpretable byte code.

:param p: (required).
:param body: (required).
:param name: (required).
:param filename: (required).
:param globalize: (optional).
:type p:
:type body:
:type name: str or unicode text
:type filename: str or unicode text
:type globalize:
:return: byte code



2. restricted builtins

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/index.rst
@@ -1,7 +1,7 @@
Usage of RestrictedPython
=========================

.. include:: api.rst
.. include:: basic_usage.rst
.. include:: framework_usage.rst
.. include:: policy.rst
.. include:: api.rst

0 comments on commit 69d7878

Please sign in to comment.