feat: generate api docs

[ijemmy]

Description of your changes

• Add TypeDoc to generate API docs. This can be run via npm run docs-generateApiDoc. The command will generate /api folder (gitignored) with TypeDoc.
• Edit on-docs-change.yml Github workflow to also generate API doc and put this on 'develop/api' folder. This follows the same convention of Python version (/api)
• For the home page of the API Doc, we are using README.md content. We can change this in the future if needed by editing the config file typedoc.js

How to verify this change

1. Check out gh-pages branch
2. Run npx live-server
3. Open link "API reference" on the left-hand menu.

Related issues, RFCs

#152

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• The code coverage hasn't decreased
• I have added tests that prove my change is effective and works
• New and existing unit tests pass locally and in Github Actions
• Any dependent changes have been merged and published in downstream module
• The PR title follows the conventional commit semantics

Breaking change checklist

• I have documented the migration process
• I have added, implemented necessary warnings (if it can live side by side)

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[ijemmy]

This is required for multi-repo with TypeDoc.

[dreamorosi]

Homepage of API Docs has a broken image/badge:

Is this intended / due to the fact that the repo is still private? If yes please feel free to resolve the discussion.

[flochaz]

Awesome !

[flochaz]

Homepage of API Docs has a broken image/badge:

Is this intended / due to the fact that the repo is still private? If yes please feel free to resolve the discussion.

I think it's indeed due to not being public