sphinx-extensions2 / sphinx-tippy

Get rich tool tips in your sphinx documentation!
https://sphinx-tippy.readthedocs.io
MIT License
35 stars 5 forks source link

Doesn't work with `-j auto` option #9

Open dbitouze opened 1 year ago

dbitouze commented 1 year ago

When sphinx-build is run with its -j auto option, sphinx-tippy doesn't work.

Indeed, consider the joined (minimal) project, the structure of which being:

├── _build
├── conf.py
├── index.rst
├── make.bat
├── Makefile
├── _static
├── _templates
└── test.rst

with the following files:

-- Project information -----------------------------------------------------

https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Test tippy' copyright = '2023, Denis' author = 'Denis' release = '0'

-- General configuration ---------------------------------------------------

https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [ 'sphinx_tippy', ]

source_suffix = ['.rst']

templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

-- Options for HTML output -------------------------------------------------

https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster' html_static_path = ['_static']

- `index.rst`:
```python
.. Test tippy documentation master file, created by
   sphinx-quickstart on Wed Sep 13 21:30:55 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Test tippy's documentation!
======================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :glob:

   *

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Sphinx <https://en.wikipedia.org/wiki/Sphinx_(documentation_generator)>__.


First, run:
```bash
sphinx-build . _build/html

and look at the _build/html/test.html page in a browser: you'll see sphinx-tippy works as expected when hovering over the “Sphinx” link (the target of which being https://en.wikipedia.org/wiki/Sphinx_(documentation_generator)).

Now, run:

make clean
sphinx-build -j auto . _build/html

and refresh the _build/html/test.html page: you'll see sphinx-tippy doesn't work anymore: nothing happens when hovering over the “Sphinx” link.

test-tippy.tar.gz