2016-06-14 7 views
0

私は初めてスフィンクスを使用してコード内のドキュメンテーションを取得しようとしています。私は現在、pycharmを使ってsphinxタスクを実行していますが、コマンドラインでも不運なことはありませんでした。問題は、プロセスがエラーを返さずに処理されるということです。Sphinxを実行していますhtml makeはソースを読み込んだ後にスタックしません

Running Sphinx v1.2.2 
loading pickled environment... done 
building [html]: targets for 1 source files that are out of date 
updating environment: 0 added, 1 changed, 0 removed 
reading sources... [100%] index 

何もしません。

私はSphinxのマニュアルとガイドをオンラインで入手できるようにしましたが、多分何か問題がありました。これらは私のindex.rstファイルです:

Welcome to Mycode's documentation! 
=================================== 

Contents: 

.. automodule:: mycode 
    :members: 

___________________________________ 

**Sub-Modules: ** 

.. toctree:: 
    :maxdepth: 2 

    mycode.TerminalColors 


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

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

そして、これは私のconf.pyです:

sys.path.insert(0, os.path.abspath('..')) 
sys.path.insert(0, os.path.abspath('../docs')) 
sys.path.insert(0, os.path.abspath('../scripts')) 
sys.path.insert(0, os.path.abspath('../source')) 
print(sys.path) 

extensions = [ 
    'sphinx.ext.autodoc', 
    'sphinx.ext.viewcode', 
    'sphinxcontrib.napoleon' 
] 

# Napoleon settings 
napoleon_google_docstring = True 
napoleon_numpy_docstring = True 
napoleon_include_private_with_doc = False 
napoleon_include_special_with_doc = True 
napoleon_use_admonition_for_examples = False 
napoleon_use_admonition_for_notes = False 
napoleon_use_admonition_for_references = False 
napoleon_use_ivar = False 
napoleon_use_param = True 
napoleon_use_rtype = True 

autodoc_member_order = 'groupwise' 

templates_path = ['.templates'] 

source_suffix = '.rst' 

master_doc = 'index' 

project = u'Mycode' 
copyright = u'2016, Me' 
version = '1.0' 
release = '1.0' 
exclude_patterns = [] 
pygments_style = 'sphinx' 

html_theme = 'default' 
html_static_path = ['.static'] 
htmlhelp_basename = 'Mycodedoc' 

latex_elements = {} 
latex_documents = [ 
    ('index', 'Mycode.tex', u'Mycode Documentation', 
    u'me', 'manual'), 
] 

man_pages = [ 
    ('index', 'mycode', u'mycode Documentation', 
    [u'me'], 1) 
] 

texinfo_documents = [ 
    ('index', 'Mycode', u'Mycode Documentation', 
    u'me', 'Mycode', 'One line description of project.', 
    'Miscellaneous'), 
] 

は最後に、これは私のプロジェクト構造である:

-mycode 
    -scripts 
     -mycode.py 
    -docs(output folder) 
     -index.html 
     -... 
    -build 
    -source 
     -conf.py 
     -index.rst 

すべてのヘルプは非常になります感謝! ありがとうございます

答えて

0

解決済みです。 wait-like関数がモジュールに含まれていると、読み込み時にSphinxが読み込まれたときに読み込まれるようになります。私はROSを使用していました。rospy.wait_for_serviceが問題を引き起こしていました。

関連する問題