Windows10环境下使用sphinx和Latex生成PDF
生成PDF比生成HTML稍微麻烦些,需要再安装一些依赖包。我在网上翻了一些资料,有在mac环境,有在linux环境下,唯独windows下的资料比较少,没办法只能自己处理这个坑了。首先在make.bat目录下打开cmd窗口,执行make latexpdf我本机报出无法识别命令 latex。使用命令 pip install -U latex该命令执行后,我继续使用make ...
生成PDF比生成HTML稍微麻烦些,需要再安装一些依赖包。
我在网上翻了一些资料,有在mac环境,有在linux环境下,唯独windows下的资料比较少,没办法只能自己处理这个坑了。
首先在make.bat目录下打开cmd窗口,执行make latexpdf
我本机报出无法识别命令 latex。
使用命令 pip install -U latex
该命令执行后,我继续使用make latexpdf
依然报出 latex无法识别的问题。
没办法,我就使用pycharm查看一下,latex有哪些包需要下载,如下图
latex开头的包太多了,我也不知道要用那个,于是我找到了一篇
这篇文章主要讲texLive相关内容,但是有些内容我正好要使用,就是latex相关包环境,和PDF中文相关环境。
于是,下载该ios文件,安装并勾选了上面latex相关环境,安装过程参考上面的链接,安装完成后测试latex命令
测试通过,完美!!!!!!!!完美!!!!!!!!完美!!!!!!!!
回到source目录下,修改conf.py文件,添加以下代码,否词执行latex时会报错:
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
'preamble': '''
\\hypersetup{unicode=true}
\\usepackage{CJKutf8}
\\AtBeginDocument{\\begin{CJK}{UTF8}{gbsn}}
\\AtEndDocument{\\end{CJK}}
''',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Python Manual.tex', 'PYTHON',
'xxxx', 'manual'),
]
注意:网上一堆资料都是要在这个地方添加东西,其实根本没必要,如图,我这里不添加照样执行:
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.todo',
'sphinx.ext.autosectionlabel',
]
最终conf文件里的内容如下,参考者看需修改:
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../../..'))
# -- Project information -----------------------------------------------------
project = 'PYTHON'
copyright = '2018, xxx'
author = 'xxxx'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.0.0'
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.todo',
'sphinx.ext.autosectionlabel',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# nature
#html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'PYTHON doc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
'preamble': '''
\\hypersetup{unicode=true}
\\usepackage{CJKutf8}
\\AtBeginDocument{\\begin{CJK}{UTF8}{gbsn}}
\\AtEndDocument{\\end{CJK}}
''',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Python Manual.tex', 'PYTHON Documentation',
'xxxx', 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'PYTHON', 'PYTHON ',
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'PYTHON', 'PYTHON',
author, 'PYTHON', 'One line description of project.',
'Miscellaneous'),
]
# -- Extension configuration -------------------------------------------------
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
注意:latex_documents中的PYTHON如果为中文,生成pdf时可能会报出utf-8字符集之类的错误。
latex_documents = [
(master_doc, 'Python Manual.tex', 'PYTHON',
'xxxx', 'manual'),
]
回到make.bat目录下,再次执行make latex命令
就会生成build目录,该目录下包含latex文件夹,其中python.tex就是我们生成的文件。
理论上来说,不需要再修改里面的字符集,但是有些朋友,字符集不对,还是看一下吧
注意:字符集不正确时,生成的pdf中可能没有中文。
最后,执行make latexpdf命令,就生成了pdf文件,如下图。
有些朋友再执行make pdf时会出现一些未知错误,这里我建议下载texstudio进行处理。
这样问题比较好解决,有什么错误直接就看出来了,如图。
更多推荐
所有评论(0)