Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generated conf.py files in release tarball incompatible with Sphinx 8.x #1576

Open
jwakely opened this issue Dec 4, 2024 · 7 comments
Open
Labels

Comments

@jwakely
Copy link
Contributor

jwakely commented Dec 4, 2024

Summary

The doc/GSG/conf.py and doc/main/conf.py files in the release tarball https://github.com/uxlfoundation/oneTBB/archive/refs/tags/v2022.0.0.tar.gz have the following line:

intersphinx_mapping = {'https://docs.python.org/': None}

Version

2022.0.0

Environment

Fedora Linux rawhide, with Sphinx 8.1.3

Observed Behavior

The documentation produces a build error:
https://bugzilla.redhat.com/show_bug.cgi?id=2329903

Expected Behavior

Builds OK.

I would send a pull request to change it, but those files seem to be generated and I'm not sure how that's done.

For more information, see https://bugzilla.redhat.com/show_bug.cgi?id=2329903 and for a similar fix in another project see jupyterlab/jupyterlab#14423

@jwakely jwakely added the bug label Dec 4, 2024
@phprus
Copy link
Contributor

phprus commented Dec 4, 2024

Fixed in master by #1480

@omalyshe
Copy link
Contributor

omalyshe commented Dec 5, 2024

@jwakely This was fixed in the release branch as well - https://github.com/uxlfoundation/oneTBB/blob/onetbb_2022/doc/conf.py#L301
For me the archive at the tag https://github.com/uxlfoundation/oneTBB/archive/refs/tags/v2022.0.0.tar.gz . Please check again.

@jwakely
Copy link
Contributor Author

jwakely commented Dec 5, 2024

The v2022.0.0.tar.gz archive has it fixed in doc/conf.py but not in the two generated files doc/GSG/conf.py and doc/main/conf.py:

tmp$ mkdir tbb
tmp$ cd tbb
tbb$ wget https://github.com/uxlfoundation/oneTBB/archive/refs/tags/v2022.0.0.tar.gz
v2022.0.0.tar.gz     100% [=========================================================================================================>]    2.53M   32.65MB/s
                          [Files: 1  Bytes: 2.53M [3.71MB/s] Redirects: 1  Todo: 0  Errors: 0                                        ]
tbb$ tar xf v2022.0.0.tar.gz 
tbb$ grep -R  intersphinx_mapping oneTBB-2022.0.0/
oneTBB-2022.0.0/doc/GSG/conf.py:intersphinx_mapping = {'https://docs.python.org/': None}
oneTBB-2022.0.0/doc/conf.py:intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
oneTBB-2022.0.0/doc/main/conf.py:intersphinx_mapping = {'https://docs.python.org/': None}

@jwakely
Copy link
Contributor Author

jwakely commented Dec 5, 2024

Ah, maybe they're not generated, they just don't exist on the master branch. But they're still wrong on the release branch:

intersphinx_mapping = {'https://docs.python.org/': None}

intersphinx_mapping = {'https://docs.python.org/': None}

@omalyshe
Copy link
Contributor

omalyshe commented Dec 5, 2024

@jwakely Oh, now I see what you mean. Thank you. Will take a look.

@omalyshe
Copy link
Contributor

omalyshe commented Dec 6, 2024

@jwakely Oh, now I see what you mean. Thank you. Will take a look.

@jwakely Those files and some others were not supposed to be in the package. It is fixed in the branch and will be fixed in the next release package. Thanks again for reporting it!

@jwakely
Copy link
Contributor Author

jwakely commented Dec 6, 2024

Great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants