Skip to content

Keep generated documentation for --help in a separate directory#9500

Merged
Ericson2314 merged 1 commit intoNixOS:masterfrom
fricklerhandwerk:generated-docs
Nov 30, 2023
Merged

Keep generated documentation for --help in a separate directory#9500
Ericson2314 merged 1 commit intoNixOS:masterfrom
fricklerhandwerk:generated-docs

Conversation

@fricklerhandwerk
Copy link
Contributor

Motivation

  • helps navigating the code as it highlights which files are generated
  • makes it less error prone when working incrementally
    (although this should be just fixed by building out of tree)

Context

picking apart #8781

@Ericson2314

Priorities

Add 👍 to pull requests you find important.

- helps navigating the code as it highlights which files are generated
- makes it less error prone when working incrementally
  (although this should be just fixed by building out of tree)
@github-actions github-actions bot added documentation new-cli Relating to the "nix" command labels Nov 30, 2023
Copy link
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I don't think it should be called index.mn.in, because we are not (yet at least) substituting any @...@ in it.

I am wrong

@Ericson2314 Ericson2314 changed the title keep generated documentation in a separate directory keep generated documentation for --help in a separate directory Nov 30, 2023
@Ericson2314 Ericson2314 changed the title keep generated documentation for --help in a separate directory Keep generated documentation for --help in a separate directory Nov 30, 2023
@Ericson2314
Copy link
Member

(I renamed because I was confused at first, this doesn't effect all generated doc-related files, just those to be used by nix)

@Ericson2314 Ericson2314 merged commit 7cc2aa7 into NixOS:master Nov 30, 2023
@fricklerhandwerk fricklerhandwerk deleted the generated-docs branch February 6, 2024 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation new-cli Relating to the "nix" command

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants