Sphinx 不为文件生成文档

Question

所以我正在使用 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`

Answer 1

extensions 配置包含 numpydoc 和 sphinx.ext.napoleon。

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

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

Sphinx 不为文件生成文档

Sphinx not generating documentation for file

python

python-sphinx