d36cd1dbc7
Some classes have docstrings, and lack rST docs (e.g. Module), few others vice versa. It's unclear what is the best way to deal with this. IMHO, docstrings should prevail, i.e. existing docs would rather be moved to docstings. Anyway, for now just make sure that users don't miss documentation, even if it's just list of classmembers.
29 lines
707 B
ReStructuredText
29 lines
707 B
ReStructuredText
+-----------------------------+
|
|
| layout: page |
|
|
+-----------------------------+
|
|
| title: Module (llvm.core) |
|
|
+-----------------------------+
|
|
|
|
llvm.core.Module
|
|
================
|
|
|
|
Modules are top-level container objects. You need to create a module
|
|
object first, before you can add global variables, aliases or functions.
|
|
Modules are created using the static method ``Module.new``:
|
|
|
|
.. code-block:: python
|
|
|
|
#!/usr/bin/env python
|
|
|
|
from llvm import *
|
|
from llvm.core import *
|
|
|
|
# create a module
|
|
my_module = Module.new('my_module')
|
|
|
|
|
|
Automatically Generated Documentation
|
|
-------------------------------------
|
|
.. autoclass:: llvm.core.Module
|
|
:members:
|
|
:undoc-members:
|