-
Notifications
You must be signed in to change notification settings - Fork 87
One click build doc #200
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.
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
One click build doc #200
Conversation
NeoZhangJianyu
commented
Oct 11, 2024
- correct the requirements.txt
- add script to build online doc by one click.
yinghu5
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's try
mkbhanda
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor comments
line 36: echo "repo ${REPO} exists, skipping cloning"
line 57: echo "CP html to
LGTM
| BUILDDIR=_build | ||
| PUBLISHDIR=${RELEASE_FOLDER}/latest | ||
|
|
||
| cp -r ${BUILDDIR}/html/* ${PUBLISHDIR} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@NeoZhangJianyu @mkbhanda @yinghu5 @chensuyue @intelkevinputnam You left out a step that's in the "make publish" steps that handles the case when a file was deleted from the previously published documents. You should remove everything from the PUBLISHDIR folder before copying all the files that were just built:
rm -rf $(PUBLISHDIR)/*
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I will update as your comment later.
Thank you!
| @@ -0,0 +1,28 @@ | |||
| #!/bin/bash | |||
|
|
|||
| sudo apt install git doxygen graphviz -y | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@NeoZhangJianyu @mkbhanda @yinghu5 @chensuyue @intelkevinputnam OPEA doesn't use doxygen?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @dbkinder for continuing to be the doc guardian angle for OPEA!!
https://doxygen.nl/index.html Doxygen "automates the generation of documentation from source code comments, parsing information about classes, functions, and variables to produce output in formats like HTML and PDF" but I see no signs of its use in our various OPEA subprojects. Just see references to it in opea-projects/docs in scripts/setup_env.sh and scripts/show-versions.py. For that matter I do not see graphviz either. Are these being included in anticipation of use @NeoZhangJianyu ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doxygen is not used in fact. It's copied from another script. I will remove it.
graphviz is used by OPEA doc build, refer to https://github.com/opea-project/docs/blob/main/developer-guides/docbuild.rst:
"
For Ubuntu, use:
sudo apt install python3-pip python3-wheel make graphviz
"
Yes, I will update as your comment later. Thank you! |