API docs in Hugo #5625
Merged
API docs in Hugo #5625
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is mostly copied from the jekyll version at xapi-project.github.io and amended for Hugo. The main difference is that all XenAPI pages have now been integrated with the main menu in the left side bar, including the menu of the XenAPI classes. Some automation is left to do in order to take the `doc/data` files from a build of `ocaml/idl` and update the class pages using the script `doc/make-class-pages.py`. Also the overview of xapi releases is still missing, as well as some of the API guides. Finally, there is some overlap with markdown files in `ocaml/doc`, which needs to be sorted out. Signed-off-by: Rob Hoes <rob.hoes@citrix.com>
psafont
reviewed
May 10, 2024
| @@ -0,0 +1,24 @@ | |||
| #!/usr/bin/env python3 | |||
There was a problem hiding this comment.
How is this script used?
It seems like some of the checked-out files here will need to be updated, same way as the current docs, what the CI plan to do this?
There was a problem hiding this comment.
Yes, see commit message. We'll need some automation for this, perhaps under a make doc-hugo command, which will build ocaml/idl, copy the xenapi.json file to doc/data and run this script. Then we can remove the checked-in class files.
lindig
approved these changes
May 13, 2024
Vincent-lau
approved these changes
May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is mostly copied from the jekyll version at xapi-project.github.io and amended for Hugo. The main difference is that all XenAPI pages have now been integrated with the main menu in the left side bar, including the menu of the XenAPI classes.
Some automation is left to do in order to take the
doc/datafiles from a build ofocaml/idland update the class pages using the scriptdoc/make-class-pages.py. Also the overview of xapi releases is still missing, as well as some of the API guides.Finally, there is some overlap with markdown files in
ocaml/doc, which needs to be sorted out.