Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate API references in documentation website #19

Open
irvinlim opened this issue Mar 25, 2022 · 0 comments
Open

Generate API references in documentation website #19

irvinlim opened this issue Mar 25, 2022 · 0 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@irvinlim
Copy link
Member

The APIs are stored in this repository, but the documentation site served using MkDocs is currently on another repository.

Rather than hand-crafting and adding generated API references in furiko-io/docs manually, we can investigate a way to generate the API references and push changes to the other repository automatically if the API here changes.
@irvinlim irvinlim added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@irvinlim