Source Mapper Improvements: Read the Docs

[tzaffi]

Problem

There currently isn't any information in our Read the Docs about source mapping. This makes it harder for developers to get started with the feature.

Solution

Add a new page, probably after the Compiler Optimization section briefly showing the usage pattern. It doesn't have to be a very long page.

Dependencies

Urgency

High - I don't consider the source mapper to even be "beta" until there are doc's that anyone can read in their official place that provide an explanation of how to use the feature.

[tzaffi]

@barnjamin

Also, we need docstrings whenever that explain the sourcemap-related params

We already have a doc-string:

• for the compiler: https://github.com/algorand/pyteal/blob/8ab346a8d095484607b53ee14489a29584161063/pyteal/compiler/compiler.py#L344

689 adds it to Router.compile() as well:

• for the router in upcoming #689: https://github.com/algorand/pyteal/blob/f94fa7a8f5ee7f5356eafb9f462c192c3a605605/pyteal/ast/router.py#L1245-L1271

[tzaffi]

Problem

There currently isn't any information in our Read the Docs about source mapping. This makes it harder for developers to get started with the feature.

Solution

Add a new page, probably after the Compiler Optimization section briefly showing the usage pattern. It doesn't have to be a very long page.

Dependencies

Urgency

High - I don't consider the source mapper to even be "beta" until there are doc's that anyone can read in their official place that provide an explanation of how to use the feature.

Addressed by #692