微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

Sphinx 不为文件生成文档

如何解决Sphinx 不为文件生成文档

所以我正在使用 Sphinx 生成文档,但其中一个文件没有显示。它是图像中的 PyTuner tuner

文件在 numpydoc 配置中有 3 个类。

这是source/conf.py

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- 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 = 'PyTuner'
copyright = '2021,Vedant Mehta'
author = 'Vedant Mehta'

# The full version,including alpha/beta/rc tags
release = '1.0.0'


# -- General configuration ---------------------------------------------------

# 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.autosummary','numpydoc','rinoh.frontend.sphinx','sphinx.ext.todo','sphinx.ext.viewcode','sphinx.ext.autodoc','sphinx.ext.napoleon'
]

# Add any paths that contain templates here,relative to this directory.
templates_path = ['_templates']

# 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 = []


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

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

这是source/index.rst

.. PyTuner documentation master file,created by
   sphinx-quickstart on Mon Feb 22 22:45:17 2021.
   You can adapt this file completely to your liking,but it should at least
   contain the root `toctree` directive.

Welcome to PyTuner's documentation!
===================================

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



PyTuner tuner 
=====================
.. autoclass:: tuner.tuner
   :members:
PyTuner tunertools
=====================
.. automodule:: tuner.tunertools
   :members:

PyTuner dropdown
===================
.. automodule:: tuner.dropdown
   :members:


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

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

Tuner file not generating

解决方法

extensions 配置包含 numpydocsphinx.ext.napoleon

我不知道您的问题的确切原因,但这些扩展非常相似,您应该只使用其中之一。

并且在“PyTuner tunertools”之前应该有一个空行。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。