feat: added doc-generator

[Sakapoi]

Description

Added generator of documentation pages for Noir lang.

Problem*

Resolves #3362

Summary*

With this documentation generator, you can create Rust doc-like documentation pages for Noir lang.

Additional Context

Documentation*

Check one:

• No documentation needed.
• Documentation included in this PR.
• [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

• I have tested the changes locally.
• I have formatted the changes with Prettier and/or cargo fmt on default settings.

[ghost]

I don’t think tokens are a good representation for generating documentation.

Found a couple of issues:

struct GrumpkinScalar {
    low: Field,
    high: Field,
}

thread 'main' panicked at 'attempt to subtract with overflow', tooling/doc_generator/src/output.rs:164:58
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

It hangs with this code:

// Map<V>
 struct B<T_C> {}

impl<T_C> B<T_C> {
    fn new(new_concrete_t_c_constructor: fn () -> T_C) -> B<T_C> {
        B { new_concrete_t_c_constructor }
    }
}

/**/

It seems that the documentation lexer is implemented incorrectly in the fork.

thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: UnterminatedBlockComment { span: Span(Span { start: ByteIndex(11), end: ByteIndex(13) }) }', tooling/doc_generator/src/getters.rs:455:45
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

trait MyTrait {
}

thread 'main' panicked at 'attempt to subtract with overflow', tooling/doc_generator/src/getters.rs:304:29
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

it seems there are still a lot of problems, but yes

[kevaundray]

@f01dab1e what is the status of this PR?

[ghost]

@kevaundray, I think you can do a merge

[kevaundray]

Before merging, can you check how this looks like on aztec-package contracts? If it doesn't work, then it makes sense to create a separate issue

[ghost]

@kevaundray

I wanted to share some feedback and issues I've encountered:

• Uninformative error messages.

• Lack of Workspace Support: Currently, there seems to be no support for workspaces. This feature would greatly enhance the user experience, especially for those handling multiple projects.

• File Path Interface Design: The interface requires specifying the path to a file rather than to a package. This approach feels a bit unintuitive and could potentially be streamlined for better usability.

• No Integration with nargo: I noticed that there's no integration with nargo. Implementing this could improve the workflow significantly, especially for those already relying on nargo for their projects.

• Issues with 'mod filename': When using the 'mod filename', it doesn't function as expected. The system seems to hardcode to input_files/{module name}.nr. Removing this leads to issues due to relative paths, making it impossible to read the file correctly.

[ghost]

In an HTML file, the source code of a function is sometimes distorted or simply truncated.

[TomAFrench]

Looks like this is directly parsing Noir source code. This is going to add extra maintenance overhead on keeping this in sync with the main parser.

I'd like to follow librustdoc and have the docs generated from the AST