diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 6f06a7095..a4de48c8b 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -22,7 +22,7 @@ jobs: sudo apt-get update sudo apt-get install -y build-essential libeigen3-dev libyaml-dev libfftw3-dev libavcodec-dev libavformat-dev libavutil-dev libswresample-dev libsamplerate0-dev libtag1-dev libchromaprint-dev python3-dev python3-numpy-dev python3-numpy python3-yaml python3-six sudo apt-get install -y doxygen python3-pip pandoc - pip3 install sphinx pyparsing sphinxcontrib-doxylink docutils jupyter sphinxprettysearchresults sphinx-toolbox + pip3 install sphinx pyparsing sphinxcontrib-doxylink docutils jupyter sphinx-toolbox # Install TensorFlow sudo sh src/3rdparty/tensorflow/setup_from_libtensorflow.sh # Install Gaia dependencies diff --git a/doc/sphinxdoc/_templates/search.html b/doc/sphinxdoc/_templates/search.html index 6a16e49d1..c8567d927 100644 --- a/doc/sphinxdoc/_templates/search.html +++ b/doc/sphinxdoc/_templates/search.html @@ -24,26 +24,10 @@

Search

{% endblock %} {% block extrafooter %} - - + - - + + + {% endblock %} diff --git a/doc/sphinxdoc/_templates/sphinxdoc_mtg/base.html b/doc/sphinxdoc/_templates/sphinxdoc_mtg/base.html index bc9780e63..3216ab69b 100644 --- a/doc/sphinxdoc/_templates/sphinxdoc_mtg/base.html +++ b/doc/sphinxdoc/_templates/sphinxdoc_mtg/base.html @@ -43,7 +43,7 @@ {%- endif %} {%- endmacro %} - + diff --git a/doc/sphinxdoc/conf.py b/doc/sphinxdoc/conf.py index a64d93201..df3f9b2e6 100644 --- a/doc/sphinxdoc/conf.py +++ b/doc/sphinxdoc/conf.py @@ -46,7 +46,7 @@ # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.viewcode', 'sphinxcontrib.doxylink', - 'sphinxprettysearchresults', + # 'sphinxprettysearchresults', 'sphinx.ext.autosectionlabel', 'sphinx_toolbox.collapse'] @@ -116,6 +116,10 @@ # a list of builtin themes. html_theme = 'sphinxdoc_mtg' +# If true, the text around the keyword is shown as summary of each search result. +# Default is True. +html_show_search_summary = False + # Add any paths that contain custom themes here, relative to this directory. html_theme_path = ['_templates'] diff --git a/doc/sphinxdoc/installing.rst b/doc/sphinxdoc/installing.rst index bd5c08bfd..86708fa47 100644 --- a/doc/sphinxdoc/installing.rst +++ b/doc/sphinxdoc/installing.rst @@ -189,7 +189,7 @@ Install doxigen and pip3. If you are on Linux:: Install additional dependencies (you might need to run this command with sudo):: - pip3 install sphinx pyparsing sphinxcontrib-doxylink docutils jupyter sphinxprettysearchresults sphinx-toolbox + pip3 install sphinx pyparsing sphinxcontrib-doxylink docutils jupyter sphinx-toolbox sudo apt-get install pandoc Make sure to build Essentia with Python 3 bindings and run::