pydata / pydata-sphinx-theme

A clean, three-column Sphinx theme with Bootstrap for the PyData community
https://pydata-sphinx-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
592 stars 309 forks source link

With `PST` 0.15.1, no more left sidebar containing the local ToC #1625

Closed dbitouze closed 8 months ago

dbitouze commented 8 months ago

With PST 0.15.1, the left sidebar containing the local ToC has disappeared:

How to make it appear again?

12rambau commented 8 months ago

the section navigation is still displayed in our own documentation (build with 0.15.1) could you share more information on your build like the conf.py and the output warnings/errors ?

dbitouze commented 8 months ago

Here is our (.tar.gz-fied) conf.py.

About the warnings/errors, once I noticed numerous warnings as follows:

/home/bitouze/latex/gutenberg/faq-gut/source/1_generalites/bases/start.md:9: WARNING: toctree glob pattern '*/start' didn't match any documents

but I couldn't retrieve them in the subsequent compilations.

BTW, another trouble (that may require another issue): the top bar disappears when scrolling down: image

12rambau commented 8 months ago

BTW, another trouble (that may require another issue): the top bar disappear when scrolling down:

That's a huge one and it also happen on our documentation, if ou can open an issue I'll try to solve it ASAP and cut a patch release

12rambau commented 8 months ago

I think your problem is related to the merge of https://github.com/pydata/pydata-sphinx-theme/pull/1609, @drammock do you think this could be a side effect of the new mechanism you introduced ?

dbitouze commented 8 months ago

BTW, another trouble (that may require another issue): the top bar disappear when scrolling down:

That's a huge one and it also happen on our documentation, if ou can open an issue I'll try to solve it ASAP and cut a patch release

Done: #1627.

drammock commented 8 months ago

I think your problem is related to the merge of #1609, @drammock do you think this could be a side effect of the new mechanism you introduced ?

it's possible. But I don't understand why it doesn't happen for our site. since @dbitouze can't provide a live site (not even a PR build? or upload to a temporary place?) my only recourse is building their site locally myself, which I don't really have time to do this week (and can't do anyway without a link to their repo at a minimum, and a nice easy setup process like an env file would help).

12rambau commented 8 months ago

I found it with the name of the website but I guess you don't read French do you ? https://gitlab.gutenberg-asso.fr/gutenberg/faq-gut

dbitouze commented 8 months ago

Here is (I guess) a minimum setup process:

git clone ssh://git@gitlab.gutenberg-asso.fr:31022/gutenberg/faq-gut.git
# or:
# git clone https://gitlab.gutenberg-asso.fr/gutenberg/faq-gut.git
cd faq-gut
mkdir build
python3 -m venv build/.venv
source build/.venv/bin/activate
python3 -m pip install --no-cache-dir -U pip
python3 -m pip install --no-cache-dir \
      Sphinx                          \
      Pillow                          \
      sphinx_comments                 \
      sphinx_design                   \
      sphinxext.opengraph             \
      myst_parser                     \
      linkify-it-py                   \
      sphinx_tippy                    \
      sphinx_sitemap                  \
      pydata_sphinx_theme             \
      sphinx_copybutton               \
      sphinx_togglebutton             \
      sphinx_examples                 \
      sphinx_last_updated_by_git
git clone ssh://git@gitlab.gutenberg-asso.fr:31022/dbitouze/pygments-acetexlexer.git
# or:
# git clone https://gitlab.gutenberg-asso.fr/dbitouze/pygments-acetexlexer.git
cd pygments-acetexlexer
python3 -m pip install --no-cache-dir .
cd ..
rm -rf pygments-acetexlexer
drammock commented 8 months ago

I found it with the name of the website but I guess you don't read French do you ? https://gitlab.gutenberg-asso.fr/gutenberg/faq-gut

I do read french (a little) but the screenshots on the PR description don't include the URL or local folder path, and don't say "gutenberg" anywhere (at least not prominently, maybe it's buried in the small print) so all I had to go on was the logo "FAQ LaTeX" --- which is so broad that I didn't even bother to put in my search engine. I didn't notice that the follow up comment had a screenshot with the browser topbar (and thus page title) visible.

lwasser commented 8 months ago

Friends - i'm running into this same issue!! This page for instance used to have a left side nav. and now it's missing.

i'm trying to test things locally to pinpoint why it's happening. on our documentation page locally, removing :hidden: seemed to make it work as expected. but then ofcourse i have dualing TOCs on the page.

here is the repo if that is somehow helpful. i'll report back if i can figure anything else out here. i did try to update all aspects of the theme to align with 15.1 including things like the favicon updates, etc. any input is appreciated.

lwasser commented 8 months ago

Discovery:


:::{toctree}
:hidden:
:caption: Publishing a package

Publish with Conda / PyPI <publish-python-package-pypi-conda>
Package versions <python-package-versions>
Code style <code-style-linting-format>

:::

removing :hidden: does seem to allow the TOCTREE to render on the left. But that is not ideal for our TOC! let me know if i can test a few other things here.

in the PR here you can see my fix was just pinning back to 14.4 for the time being. i'm going to merge that but am still very happy to help with testing.