Skip to content

Rebuild doxygen docs when headers change#10536

Merged
edolstra merged 2 commits into
NixOS:masterfrom
hercules-ci:doc-doxygen-make-rebuild
Apr 26, 2024
Merged

Rebuild doxygen docs when headers change#10536
edolstra merged 2 commits into
NixOS:masterfrom
hercules-ci:doc-doxygen-make-rebuild

Conversation

@roberth

@roberth roberth commented Apr 17, 2024

Copy link
Copy Markdown
Member

Motivation

Make it easy to review rendered docs.

Context

Priorities and Process

Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

@roberth roberth added documentation contributor-experience Developer experience for Nix contributors c api Nix as a C library with a stable interface labels Apr 17, 2024
@roberth roberth requested a review from edolstra as a code owner April 17, 2024 15:30
@edolstra

Copy link
Copy Markdown
Member

I'm a bit worried that in conjunction with #10527 this will degrade the edit-compile experience, since every change to a header file will now trigger a doxygen rebuild, which is pretty noisy.

@roberth

roberth commented Apr 18, 2024

Copy link
Copy Markdown
Member Author

I'd checked that make default check && make install && make installcheck doesn't run it. That's what we recommend on the hacking page, but installPhase will run it, you're right.

Is a fast manual make sufficient, or should I add an override to installTargets? Can be done in the devshell, so that it doesn't pollute package.nix.
It's not actually that slow btw; just very noisy.

@edolstra edolstra merged commit 2f67833 into NixOS:master Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c api Nix as a C library with a stable interface contributor-experience Developer experience for Nix contributors documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants