diff --git a/.new_docs/api_docs/README.md b/.new_docs/api_docs/README.md new file mode 100644 index 0000000000..4da649deca --- /dev/null +++ b/.new_docs/api_docs/README.md @@ -0,0 +1,21 @@ +# API文档生成 + +## 环境要求 +- Ubuntu +- python >= 3.6 + +## 前置依赖安装 + +``` +sudo apt-get install doxygen + +pip install -r python/requirements.txt +``` + +## 文档生成 + +``` +bash build.sh +``` + +执行完成后,浏览器打开当前目录下的`index.html`即可查阅API文档 diff --git a/.new_docs/api_docs/build.sh b/.new_docs/api_docs/build.sh new file mode 100644 index 0000000000..e064140c32 --- /dev/null +++ b/.new_docs/api_docs/build.sh @@ -0,0 +1,9 @@ +CURRENT_DIR=${PWD} + +cd cpp +doxygen + +cd ../python +make html + +cd ${CURRENT_DIR} diff --git a/.new_docs/api_docs/cpp/docs/.gitignore b/.new_docs/api_docs/cpp/.gitignore similarity index 100% rename from .new_docs/api_docs/cpp/docs/.gitignore rename to .new_docs/api_docs/cpp/.gitignore diff --git a/.new_docs/api_docs/cpp/Doxyfile b/.new_docs/api_docs/cpp/Doxyfile index b5f23f5c03..4bd48f09d7 100644 --- a/.new_docs/api_docs/cpp/Doxyfile +++ b/.new_docs/api_docs/cpp/Doxyfile @@ -791,6 +791,7 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = ../../../fastdeploy/ +INPUT += ./main_page.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -982,7 +983,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = main_page.md +USE_MDFILE_AS_MAINPAGE = ./main_page.md #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1666,7 +1667,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/.new_docs/api_docs/index.html b/.new_docs/api_docs/index.html new file mode 100644 index 0000000000..4f65912813 --- /dev/null +++ b/.new_docs/api_docs/index.html @@ -0,0 +1,13 @@ +