Commits

Chris Mutel  committed dfd2abf

Start calc documentation

  • Participants
  • Parent commits be31b4d

Comments (0)

Files changed (3)

File docs/conf.py

 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import sys
+from os.path import abspath, dirname
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# Make sure we use this copy of Brightway2
+sys.path.insert(1, abspath(dirname(dirname(__file__))))
 
 # -- General configuration -----------------------------------------------------
 

File docs/index.rst

 .. toctree::
    :maxdepth: 2
 
+   technical
 
 
 Indices and tables

File docs/technical.rst

+Technical guide
+***************
+
+Static calculations
+===================
+
+
+Uncertainty analysis
+====================
+
+
+Calculation classes
+===================
+
+.. autoclass:: bw2calc.LCA
+    :members:
+
+.. autoclass:: bw2calc.SimpleRegionalizedLCA
+    :members:
+
+.. autoclass:: bw2calc.MonteCarloLCA
+    :members:
+
+.. autoclass:: bw2calc.ParallelMonteCarlo
+    :members: