Add API docs

[kcpevey]

Changes introduced in this PR:

• add api doc md file
• add script to generate md file
• add gh workflow to autogenerate docs

Reference Issues or PRs

Partially resolves nebari-dev/nebari-docs#157

What does this implement/fix?

• Documentation Update

Testing

• Did you test the pull request locally?
• Did you add new tests?

Any other comments?

There is a sister PR on the nebari-docs repo to add it this actual file to the documentation. I still need to add a separate GH action to open the PR on the nebari-docs repo

This PR supercedes this one which was failing due to credentials access via a fork.

[iameskild]

Hi @kcpevey I left a few questions and comments but otherwise this is looking good.

I think having API docs will not only be useful for newcomers but for us as maintainers as well. Reviewing the API docs makes it more obvious where we need to make improvements :)

[iameskild]

I tested this as much as far as I could on my local machine and I was able to render the API docs cli.html and they look good to me. I left one minor comment but otherwise, I think this is ready to go! Thanks @kcpevey

[kcpevey]

I will try to bring this up to date with the CI fixes on develop this week.

[iameskild]

Hi @kcpevey, this should be ready to merge right? CI is failing at the moment because the DigitalOcean token has expired (I lack the access at the moment to update it) but once the kubernetes test passes, I'm good with merging this :)

[iameskild]

@kcpevey is this PR ready to merge? If you're busy, I can wrap this up.

[kcpevey]

This should be ready to go.

[iameskild]

Hey @kcpevey, do you have time this week to resolve the merge conflicts? Once that's done, I believe this can be merged :)

[iameskild]

Hey @kcpevey, this looks like it's really close, do you have a few minutes to help resolve this conflicts? Once that's done, we can merge this PR.

[kcpevey]

I struggled a good bit trying to get Typer to render like I wanted. The sphinx extension sphinx-click does a good job, but there are still two issues that have no resolution at this point.

1. The rich markdown coloring of the help docs is not understood by sphinx-click. This is a known issue marked low priority in sphinx-click (rich markup shows when using sphinx-click ewels/rich-click#48).
2. The name of the program appears to be main. I tried renaming the files, setting prog_name (Support passing prog_name fastapi/typer#120), renaming the imports, and a bunch of other things but didn't find a solution.

I'm not sure how people feel about these "warts". I could programmatically do some find/replace on the output html, or we can accept as is.