Fix missing conf.py files during docbuilding#40904
Conversation
|
Works for me, thanks |
|
Documentation preview for this PR (built with commit d79c996; changes) is ready! 🎉 |
|
|
|
I do have issues, I have few instances of something like Maybe I do something wrong or I am missing something? |
I suppose this is the first time you're trying to build docs using a sagemath compiled with meson? This is a known issue caused by cython wrongly embedding the absolute paths of source files, and the original source files being absent (which also causes a bunch of test failures, especially in Should be fixed once cython/cython#6755 is merged in cython, which unfortunately seems stalled. In the meantime I'm just patching out these warnings, which seem harmless (at least I can't see anything wrong with the generated docs for the affected methods). See https://gitlab.archlinux.org/archlinux/packaging/packages/sagemath-doc/-/blob/10.7-1/warnings.patch?ref_type=tags |
|
Effectively, it is the first time I have gone that far with meson :) I'll give your patch a go. |
|
Well, I have now a seemingly working html documentation package for sage-on-gentoo. I still have to check the files themselves, but it builds and install. |
Thanks, fixed!
Awesome! @antonio-rojas shall we add your patch here, so that not everyone has to ignore the warning downstream? |
I'm not sure about that. 'error while formatting arguments' sounds like something that could indicate an actual problem in other cases. |
sagemathgh-40904: Fix missing `conf.py` files during docbuilding <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Fixes the issue mentioned in sagemath#39030 (comment): ``` [tutorial ] Configuration error! [tutorial ] Versions [tutorial ] ======== [tutorial ] * Platform: linux; (Linux-6.15.7-arch1-1-x86_64-with-glibc2.42) [tutorial ] * Python version: 3.13.7 (CPython) [tutorial ] * Sphinx version: 8.2.3 [tutorial ] * Docutils version: 0.21.2 [tutorial ] * Jinja2 version: 3.1.6 [tutorial ] * Pygments version: 2.19.2 [tutorial ] Last Messages [tutorial ] ============= [tutorial ] None. [tutorial ] Loaded Extensions [tutorial ] ================= [tutorial ] None. [tutorial ] Traceback [tutorial ] ========= [tutorial ] File "/usr/lib/python3.13/site- packages/sphinx/config.py", line 354, in read [tutorial ] raise ConfigError( [tutorial ] __("config directory doesn't contain a conf.py file (%s)") % confdir [tutorial ] ) [tutorial ] sphinx.errors.ConfigError: config directory doesn't contain a conf.py file (/build/sagemath-doc- git/src/build/src/doc/ru/tutorial) [tutorial ] The full traceback has been saved in: [tutorial ] /tmp/sphinx-err-6fr5ejwk.log [tutorial ] To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks! [tutorial ] Please also report this if it was a user error, so that a better error message can be provided next time. ``` ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#40904 Reported by: Tobias Diez Reviewer(s):
Fixes the issue mentioned in #39030 (comment):
📝 Checklist
⌛ Dependencies