A94 Amber Docs generator

[Ph0enixKM]

Create a way to generate documentation. The implementation should:

• Generate each markdown file for each module that is part of the project
• Collect freestanding comment docs as documentation body
• Aggregate comment docs that are directly above function declarations as the function documentation
• Get the function signature and render it in the docs
• Do not iterate through the external files
• Error when no input specified
• Accept output directory (defaults to docs/)

[Mte90]

Looking at the code there are too many conflicts maybe because it is changed a lot in the meantime?

I was looking to https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html and #237

[Mte90]

This PR can get the maximum priority?
So we can start working on the documentation?

[Ph0enixKM]

@Mte90 Now that the major bugs that had to be fixed by me are now gone - I will focus on this task

[Mte90]

Can be approved? @Ph0enixKM

[Ph0enixKM]

@Mte90 I gave myself more time to think this through if this is the format that should be generated. Have you tested it?

amber --docs test.ab

The above instruction will generate test.md file with the documentation. It works that for each file that it includes it generates appropriate file in the same directory a new markdown file. I'm still thinking if this is the best way to do it. Probably creating a separate directory docs/ with all the files would be a better approach. And also I'm thinking that this should check whether we are importing files from the same root directory or not. If we import some third party library, then this shouldn't generate documentation for it.

[Ph0enixKM]

I want to convert it to draft since I think I have to fix the issue I described before. I've added the appropriate code to the contributing guide

[Mte90]

I approve the idea of a dedicated docs folder, so we can see later how to implement that in the website repo.

[Ph0enixKM]

Here is a piece of the documentation generated by the generator:

This is a documentation
That involves many interesting things

test

fun test(a: Text): Null 

This function is a test function
Here is an example:

test("Hello, World!")

foo

fun foo(a: [Num] = [1, 2, 3]): [Num] 

This also is a pretty interesting function

[Ph0enixKM]

@Mte90 This PR is ready

[KrosFire]

Looks pretty good to me

[Ph0enixKM]

@KrosFire can you actually approve this PR so that we can merge?