Add API docs

[kcpevey]

Fixes | Closes | Resolves #

Changes introduced in this PR:

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

Types of changes

What types of changes does your PR introduce?

• Documentation Update

Testing

Requires testing

• Yes
• No

In case you checked yes, did you write tests?

• Yes
• No

Documentation

Does your contribution include breaking changes or deprecations?
If so have you updated the documentation?

• Yes, docstrings
• Yes, main documentation
• Yes, deprecation notices

Further comments (optional)

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered and more.

[kcpevey]

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

[aktech]

/bot run tests

[github-actions]

Contributor Tests Triggered by @aktech

• via comment
• Build is running here

[costrouc]

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

@kcpevey is this PR ready for review or testing? Looks like you said it depends on nebari-docs?

[kcpevey]

@costrouc this is ready for review.

Now that I'm looking at it, it could use some updating since it was pre-rename.

[kcpevey]

@trallard this is still failing to find the secret called NEBARI_SENSEI_API_DOCS_PR_OPENER. Has it been added here? I dont have permissions to check.

[aktech]

The secret is already added, but it won't be accessible by actions run by PR from forks. We would need to trigger via contributor tests:

[kcpevey]

Thanks @aktech. I'll look into that.

[kcpevey]

This is being superseded by #1634