美文网首页
Sphinx 文档入门教程

Sphinx 文档入门教程

作者: 小杰杰杰 | 来源:发表于2021-02-01 14:49 被阅读0次

    Sphinx

    安装

    pip install -U Sphinx
    

    创建项目

    sphinx-quickstart
    

    编译成html

    sphinx-build -b html sourcedir builddir
    

    或者

    make html
    

    国际化

    安装sphinx-intl

    pip install sphinx-intl
    

    conf.py里添加配置

    locale_dirs = ['locale/']   # path is example but recommended.
    gettext_compact = False     # optional.
    

    将文档的可翻译消息提取到Pot文件中:

    make gettext
    

    设置/更新 locale_dir:

    sphinx-intl update -p _build/gettext -l de -l ja
    

    完成后,您获得了包含po文件的以下目录:

    ./locale/de/LC_MESSAGES/
    ./locale/ja/LC_MESSAGES/
    

    在以下位置翻译您的po文件 ./locale/<lang>/LC_MESSAGES/.

    编译成html

    make -e SPHINXOPTS="-D language='de'" html
    

    相关文章

      网友评论

          本文标题:Sphinx 文档入门教程

          本文链接:https://www.haomeiwen.com/subject/rrijtltx.html