2017-06-29 13 views
0

我正在尝试使用rst2pdf生成pdf,但不断收到错误“格式未解决,可能缺少目标URL或未定义的目标”。Sphinx pdfbuilder格式未解决,可能缺少URL

我使用sphinx生成.rst文件,并且能够生成HTML输出。

要生成我也跟着在说明PDF:https://gist.github.com/alfredodeza/7fb5c667addb1c6963b9

目录结构: - sphinxtext
*文档
**源
**建
* test.py

的conf .py:

# -*- coding: utf-8 -*- 
# 
# Test documentation build configuration file, created by 
# sphinx-quickstart on Fri Jun 30 12:08:40 2017. 
# 
# This file is execfile()d with the current directory set to its 
# containing dir. 
# 
# Note that not all possible configuration values are present in this 
# autogenerated file. 
# 
# All configuration values have a default; values that are commented out 
# serve to show the default. 

# 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('..\..')) 


# -- 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.coverage','rst2pdf.pdfbuilder'] 

# 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' 

# General information about the project. 
project = u'Test' 
copyright = u'2017, m.a.' 
author = u'm.a.' 

# The version info for the project you're documenting, acts as replacement for 
# |version| and |release|, also used in various other places throughout the 
# built documents. 
# 
# The short X.Y version. 
version = u'1.0.0' 
# The full version, including alpha/beta/rc tags. 
release = u'1.0.0' 

# 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 patterns also effect to html_static_path and html_extra_path 
exclude_patterns = [] 

# The name of the Pygments (syntax highlighting) style to use. 
pygments_style = 'sphinx' 

# If true, `todo` and `todoList` produce output, else they produce nothing. 
todo_include_todos = False 


# -- Options for HTML output ---------------------------------------------- 

# The theme to use for HTML and HTML Help pages. See the documentation for 
# a list of builtin themes. 
# 
html_theme = 'alabaster' 

# 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'] 


# -- Options for HTMLHelp output ------------------------------------------ 

# Output file base name for HTML help builder. 
htmlhelp_basename = 'Testdoc' 


# -- 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': '', 

    # Latex figure (float) alignment 
    # 
    # 'figure_align': 'htbp', 
} 

# 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, 'Test.tex', u'Test Documentation', 
    u'm.a.', '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, 'test', u'Test Documentation', 
    [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, 'Test', u'Test Documentation', 
    author, 'Test', 'One line description of project.', 
    'Miscellaneous'), 
] 

# -- Options for pdf output ------------------------------------------- 

pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'Your Name'),] 
# index - master document 
# rst2pdf - name of the generated pdf 
# Sample rst2pdf doc - title of the pdf 
# Your Name - author name in the pdf 

test.py

class Test(object): 
    ''' 
    Test class 
    ''' 

    def __init__(self,**kwargs): 
     """ 
     Constructor 
     """ 



    def some_func(self,a,b,c,d,e,f,g): 
     """ 
     Function that does something TEST 

     :param a: Identifier 
     :param b: b 
     :param c: c 
     :param d: d 
     :param e: e 
     :param f: f 
     :param g: g 
     :type a: int 
     :type b: float 
     :type c: float 
     :type d: float 
     :type e: float 
     :type f: float 
     :type h: float 
     :returns: Test obj 


     :Example: 

     >>> test=Test() 
     >>> test.some_func(10, 42164., 0.0, 0., -132.0, 0.0, 0.0) 




     """ 


     self.a=a 
     self.b = b 
     self.c = c 
     self.d = d 
     self.e = e 
     self.f = f 
     self.g = g 

     return self 

当为html我看到下面的警告建设:检查一致性... C:\路径\文档\源\ modules.rst:不包括任何toctree

文件:警告

我index.rst文件:星期五君

.. Test documentation master file, created by 

狮身人面像,快速入门30 12点08分40秒2017年 您可以完全适应这个文件根据自己的喜好,但它至少应该 包含根toctree指令。

Welcome to Test's documentation! 
================================ 

.. toctree:: 
    :maxdepth: 2 
    :caption: Contents: 

    test 


Indices and tables 
================== 

* :ref:`genindex` 
* :ref:`modindex` 
* :ref:`search` 

我test.rst:

Test Module! 
================================ 

.. automodule:: test 
    :members: 
+0

这个问题可能是什么错误消息指示。 PDF中不能有无效的链接。尝试将其构建为HTML并查找任何警告而不是错误。也许有更多的帮助? –

+0

当通过html构建时,我看到的警告是: 检查一致性... C:\ PATH \ docs \ source \ modules.rst:警告:文档不包含在任何toctree –

+0

这是否与我的index.rst?我把它保留为默认值 –

回答

0

这现在已经在rst2pdf通过PR 619解决。

您可以安装rst2pdf的版本有此修复程序通过这样做:

$ cd {some directory where you keep 3rd-party projects, e.g. ~/projects} 
$ git clone https://github.com/rst2pdf/rst2pdf.git 
$ cd rst2pdf 
$ python setup.py install 
+0

我会试试看,谢谢! –

相关问题