Merge branch 'dev' into example/simple_scripts

.readthedocs.yml

@@ -0,0 +1,14 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation with MkDocs
+mkdocs:
+  configuration: "mkdocs.yml"
+  fail_on_warning: false
+
+# Build all formats
+formats: all

README.md

@@ -53,7 +53,7 @@ A short non-complete introduction in starting to write smart contracts follows.
 1. Make sure you understand python. Eopsin works like python and uses python. There are tons of tutorials for python, choose what suits you best.
 2. Make sure your contract is valid python and the types check out. Write simple contracts first and run them using `eopsin eval` to get a feeling for how they work.
 3. Make sure your contract is valid eopsin code. Run `eopsin compile` and look at the compiler erros for guidance along what works and doesn't work and why.
-4. Dig into the [`examples`](https://github.com/ImperatorLang/eopsin/tree/master/examples) to understand common patterns. Check out the [`prelude`](https://github.com/ImperatorLang/eopsin/blob/master/eopsin/prelude.py) for understanding how the Script Context is structured and how complex datums are defined.
+4. Dig into the [`examples`](https://github.com/ImperatorLang/eopsin/tree/master/examples) to understand common patterns. Check out the [`prelude`](https://imperatorlang.github.io/eopsin/eopsin/prelude.html) for understanding how the Script Context is structured and how complex datums are defined.
 
 A simple contract called the "Gift Contract" verifies that only specific wallets can withdraw money.
 They are authenticated by a signature.

build_docs.sh

@@ -0,0 +1,4 @@
+#! /bin/bash
+pip install handsdown
+handsdown --external `git config --get remote.origin.url` -n eopsin --branch master --create-configs --exclude venv
+

docs/README.md

@@ -0,0 +1,34 @@
+# eopsin Index
+
+> Auto-generated documentation index.
+
+A full list of [eopsin](https://github.com/ImperatorLang/eopsin) project modules.
+
+- [Eopsin](eopsin/index.md#eopsin)
+    - [Module](eopsin/module.md#module)
+    - [Compiler](eopsin/compiler.md#compiler)
+    - [Optimize](eopsin/optimize/index.md#optimize)
+        - [OptimizeRemoveDeadvars](eopsin/optimize/optimize_remove_deadvars.md#optimizeremovedeadvars)
+        - [OptimizeRemovePass](eopsin/optimize/optimize_remove_pass.md#optimizeremovepass)
+        - [OptimizeVarlen](eopsin/optimize/optimize_varlen.md#optimizevarlen)
+    - [Prelude](eopsin/prelude.md#prelude)
+    - [Rewrite](eopsin/rewrite/index.md#rewrite)
+        - [RewriteAugAssign](eopsin/rewrite/rewrite_augassign.md#rewriteaugassign)
+        - [RewriteForbiddenOverwrites](eopsin/rewrite/rewrite_forbidden_overwrites.md#rewriteforbiddenoverwrites)
+        - [RewriteImport](eopsin/rewrite/rewrite_import.md#rewriteimport)
+        - [RewriteImportDataclasses](eopsin/rewrite/rewrite_import_dataclasses.md#rewriteimportdataclasses)
+        - [RewriteImportHashlib](eopsin/rewrite/rewrite_import_hashlib.md#rewriteimporthashlib)
+        - [RewriteImportPlutusData](eopsin/rewrite/rewrite_import_plutusdata.md#rewriteimportplutusdata)
+        - [RewriteImportTyping](eopsin/rewrite/rewrite_import_typing.md#rewriteimporttyping)
+        - [Rewrite Inject Builtin Constr](eopsin/rewrite/rewrite_inject_builtin_constr.md#rewrite-inject-builtin-constr)
+        - [RewriteInjectBuiltins](eopsin/rewrite/rewrite_inject_builtins.md#rewriteinjectbuiltins)
+        - [RewriteRemoveTypeStuff](eopsin/rewrite/rewrite_remove_type_stuff.md#rewriteremovetypestuff)
+        - [RewriteTupleAssign](eopsin/rewrite/rewrite_tuple_assign.md#rewritetupleassign)
+    - [Tests](eopsin/tests/index.md#tests)
+        - [Test Builtins](eopsin/tests/test_builtins.md#test-builtins)
+        - [Test Misc](eopsin/tests/test_misc.md#test-misc)
+        - [Test Ops](eopsin/tests/test_ops.md#test-ops)
+        - [Test Stdlib](eopsin/tests/test_stdlib.md#test-stdlib)
+    - [Type Inference](eopsin/type_inference.md#type-inference)
+    - [TypedAST](eopsin/typed_ast.md#typedast)
+    - [Util](eopsin/util.md#util)

docs/_config.yml

@@ -0,0 +1,4 @@
+theme: jekyll-theme-cayman
+show_downloads: true
+source: "https://github.com/ImperatorLang/eopsin"
+highlighter: rouge