FIX: do not prettify primary sidebar html

[12rambau]

Fix #929

same explaination as in my comment in the issue:

it seems that the problem is related to how we build the sidebar itself.

the generated html is:

<ul class="current nav bd-sidenav">
 <li class="toctree-l1">
  <a class="reference internal" href="page1.html">
   <cite>
    test
   </cite>
   .test
  </a>
 </li>
 <li class="toctree-l1 current active">
  <a class="current reference internal" href="#">
   test
  </a>
 </li>
</ul>

for the specific li "test.test" this is interpreted by my browser (and apparently yours) as:

<li class="toctree-l1">
  <a class="reference internal" href="page1.html">
    <cite> test </cite>
    " .test "
  </a>
</li>

which look like this:

This piece of code is generated by this function

pydata-sphinx-theme/src/pydata_sphinx_theme/__init__.py

Line 309 in 8d32801

def generate_toctree_html(kind, startdepth=1, show_nav_level=1, **kwargs):

. I did some testing and it seems that removing the prettify() function from beautifulsoup is solving the problem as the output becomes:

<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="page1.html"><cite>test</cite>.test</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">test</a></li>
</ul>

which look like:

[choldgraf]

Interesting - that was some nice investigation.