本工具基于sphinx,用于将openGuass的文档转换成html,pdf格式。
Windows,ubuntu 18.04,python3
安装sphinx
pip install sphinx
安装myst_parser
pip install myst-parser
- README.md
- source
- _static
- _templates
- Appendix
- content
- index.rst
- conf.py
- html2pdf
markdown文档位于content文件夹,index.rst为入口文件
index.rst
Welcome to openGauss's documentation!
=====================================
.. toctree::
Appendix/Appendix
Appendix/Appendix.rst:
.. toctree::
常见问题解答FAQ
错误日志信息参考
../content/zh/docs/Appendix/术语表
toctree
下配置文档的路径,可根据实际需求修改
./make html
文档生成在build/html
安装texlive2022
生成pdf
./make latexpdf
安装生成pdf需要的latex的组件
sudo apt-get install texmaker gummi texlive texlive-full texlive-latex-recommended latexdraw intltool-debian lacheck libgtksourceview2.0-0 libgtksourceview2.0-common lmodern luatex po-debconf tex-common texlive-binaries texlive-extra-utils texlive-latex-base texlive-latex-base-doc texlive-luatex texlive-xetex texlive-lang-cyrillic texlive-fonts-extra texlive-science texlive-latex-extra texlive-pstricks
生成pdf
make latexpdf
文档生成在build/latex
本工具用于将sphinx生成的html转换成pdf
wkhtmltopdf 0.12.6
python loadHtml.py
python generatePdf.py
生成的pdf文件在output.pdf