search

sphinx-contrib / sphinx-pretty-searchresults

Sphinx: pretty search results is an extension for the Sphinx documentation tool. To display search results, Sphinx is fetching the source files of search hits and rendering excerpts in raw markup. This extension removes the markup from these source files (during build time), so the search results look decent.
https://pypi.python.org/pypi/sphinxprettysearchresults
MIT License
22 stars 5 forks source link

TypeError: unsupported operand type(s) for +: 'NoneType' and 'str' #30

Open jyn514 opened 4 years ago

jyn514 commented 4 years ago

The steps I took were

git clone https://gitlab.com/YottaDB/DB/YDBDoc/ && cd YDBDoc
pip install sphinxprettysearchresults
make dirhtml

Looks like source_suffix is None when it shouldn't be?

# Sphinx version: 1.8.5
# Python version: 3.8.2 (CPython)
# Docutils version: 0.15.2 release
# Jinja2 version: 2.10.1
# Last messages:
#   done
#   copying extra files...
#   done
#   dumping search index in English (code: en) ...
#   done
#   dumping object inventory...
#   done
#   build succeeded.
#   
#   The HTML pages are in AcculturationGuide/_build/dirhtml.
# Loaded extensions:
#   sphinx.ext.mathjax (1.8.5) from /usr/lib/python3/dist-packages/sphinx/ext/mathjax.py
#   alabaster (0.7.8) from /usr/lib/python3/dist-packages/alabaster/__init__.py
#   sphinx.ext.autodoc (1.8.5) from /usr/lib/python3/dist-packages/sphinx/ext/autodoc/__init__.py
#   sphinx.ext.doctest (1.8.5) from /usr/lib/python3/dist-packages/sphinx/ext/doctest.py
#   sphinx.ext.coverage (1.8.5) from /usr/lib/python3/dist-packages/sphinx/ext/coverage.py
#   sphinx.ext.githubpages (1.8.5) from /usr/lib/python3/dist-packages/sphinx/ext/githubpages.py
#   sphinxprettysearchresults (unknown version) from /home/joshua/.local/lib/python3.8/site-packages/sphinxprettysearchresults/__init__.py
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/sphinx/cmd/build.py", line 304, in build_main
    app.build(args.force_all, filenames)
  File "/usr/lib/python3/dist-packages/sphinx/application.py", line 369, in build
    self.emit('build-finished', None)
  File "/usr/lib/python3/dist-packages/sphinx/application.py", line 510, in emit
    return self.events.emit(event, self, *args)
  File "/usr/lib/python3/dist-packages/sphinx/events.py", line 80, in emit
    results.append(callback(*args))
  File "/home/joshua/.local/lib/python3.8/site-packages/sphinxprettysearchresults/__init__.py", line 67, in build_search_snippets
    clean_txts(app.config.language, app.srcdir, app.outdir, source_suffixes, app.config.use_old_search_snippets)
  File "/home/joshua/.local/lib/python3.8/site-packages/sphinxprettysearchresults/__init__.py", line 61, in clean_txts
    os.rename(os.path.join(root, file), os.path.join(root, file.replace('.txt', source_suffix + '.txt')))
TypeError: unsupported operand type(s) for +: 'NoneType' and 'str'