Since version 0.2 of autodocsumm, we are seeing the following warning when building ou

hi <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="

Warning when building documentation with v0.2.0 or v0.2.1 about autodocsumm HOT 2 CLOSED

chilipp commented on July 26, 2024

Warning when building documentation with v0.2.0 or v0.2.1

from autodocsumm.

Comments (2)

Chilipp commented on July 26, 2024

hi @bouweandela! thanks for reporting this! Could you simply post a python module file that you think reproduces this bug? Then I can make a small setup with sphinx to test it.

from autodocsumm.

bouweandela commented on July 26, 2024

Here is a fairly minimal example:

I generated a default sphinx configuration using sphinx-quickstart and appended the following code to the generated conf.py:

import sys
from pathlib import Path

sys.path.insert(0, str(Path(__file__).absolute().parent))

extensions = [
    "sphinx.ext.autodoc",
    "autodocsumm",
]

autodoc_default_options = {
    "members": True,
    "autosummary": True,
}

content of test.py:

from itertools import product

content of index.rst:

.. automodule:: test

Running

make clean && make html

then results in:

Removing everything under '_build'...
Running Sphinx v3.1.2
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index                                                                                                             
/home/bandela/src/test/test.py:docstring of test:1:<autosummary>:1: WARNING: Inline emphasis start-string without end-string.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                              
generating indices...  genindex py-modindexdone
writing additional pages...  searchdone
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 1 warning.

The HTML pages are in _build/html.

from autodocsumm.

Recommend Projects