View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0007954 | GNUnet | documentation | public | 2023-10-11 16:43 | 2024-03-07 20:24 |
| Reporter | thejackimonster | Assigned To | schanzen | ||
| Priority | normal | Severity | minor | Reproducibility | always |
| Status | closed | Resolution | won't fix | ||
| Product Version | Git master | ||||
| Target Version | 0.21.0 | Fixed in Version | 0.21.0 | ||
| Summary | 0007954: Bootstrap script fails if sphinx theme is missing | ||||
| Description | Currently it's required to have the python "sphinx_book_theme" installed to run `./bootstrap` which implies it's required to build GNUnet. I don't think that should be the case. Generating the documentation in certain style or theme is not that important to most developers, I assume. So I think there should be an option to skip the part crashing the script if the theme is not installed or it shouldn't be part of that script in the first place. Afterall the theme should only be required to generate the documentation output. | ||||
| Steps To Reproduce | - Clone gnunet repository - Run `./bootstrap` | ||||
| Additional Information | This is the output I got: Removing folder 'libltdl'... Synchronizing submodule url for 'contrib/gana' Synchronizing submodule url for 'contrib/sphinx' Updating GANA... Updating GNS record types Creating default TLDs Updating GNUnet signatures Updating DHT record types Generating GNUnet error types GANA finished Updating handbook... rm -rf _build Theme error: no theme named 'sphinx_book_theme' found (missing theme.conf?) make: *** [Makefile:23: html] Error 2 | ||||
| Tags | No tags attached. | ||||
|
|
This is indended. ./bootstrap is only done by developers. Developers must always ensure, that the documentation also builds. (as it is unclear what potentially changed). ./bootstrap copies the compiled theme to doc/, which means that now ./configure does NOT require sphinx at all. That was the goal. So, for example, the sphinx theme is not a dependency to build the tarball now. |
|
|
0.21 released |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2023-10-11 16:43 | thejackimonster | New Issue | |
| 2023-10-13 07:53 | schanzen | Assigned To | => schanzen |
| 2023-10-13 07:53 | schanzen | Status | new => resolved |
| 2023-10-13 07:53 | schanzen | Resolution | open => won't fix |
| 2023-10-13 07:53 | schanzen | Note Added: 0020571 | |
| 2023-10-13 23:15 | schanzen | Target Version | => 0.21.0 |
| 2024-03-05 16:28 | schanzen | Fixed in Version | => 0.21.0 |
| 2024-03-07 20:24 | schanzen | Note Added: 0021776 | |
| 2024-03-07 20:24 | schanzen | Status | resolved => closed |
