Skip to content

Conversation

@twiggler
Copy link
Contributor

@twiggler twiggler commented Sep 8, 2025

No description provided.

@twiggler twiggler requested a review from Miauwkeru September 8, 2025 07:56
@Miauwkeru
Copy link
Collaborator

I think it would be a good idea to remove --fail-on-warning from

SPHINXOPTS ?= -jauto -w $(BUILDDIR)/warnings.log --fail-on-warning
for now.

This is because there is no consensus yet on #91 and the --fail-on-warning will now stop the docs from building on readthedocs

@twiggler twiggler changed the title Release 3.20 Release 3.20.1 Sep 10, 2025
Co-authored-by: Miauwkeru <Miauwkeru@users.noreply.github.com>
@JSCU-CNI
Copy link
Contributor

By removing --fail-on-warning from the build process you will be silently ignoring broken and/or missing documentation pages and sections. I suggest fixing the warnings instead of ignoring them.

@Miauwkeru
Copy link
Collaborator

By removing --fail-on-warning from the build process you will be silently ignoring broken and/or missing documentation pages and sections. I suggest fixing the warnings instead of ignoring them.

This will only happen for now, the plan is move the --fail-on-warning on the test pipeline inside the project instead of it being there globally. I'll have a PR ready for this once this PR gets merged.

As mentioned in #91, and reiterating it here. There are some warnings right now that will stop the docs from getting build and published on docs.dissect.tools due to --fail-on-warning being there. The warnings themselves only have a relation to a duplicate definition, that only occurs when building the whole documentation. These warnings also cannot be ignored.
I repeat, these warnings have no relation to broken and or missing documentation pages, and the removal of this is so the new documentation is actually available on docs.dissect.tools for dissect 3.20.1

@twiggler twiggler merged commit ab06e2d into main Sep 18, 2025
1 check passed
@twiggler twiggler deleted the bump-deps branch September 18, 2025 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants