Unverified Commit 833f9d5e authored by Robert Hensing's avatar Robert Hensing Committed by GitHub
Browse files

Merge pull request #200646 from hercules-ci/options-markdown-and-errors 

`nixosOptionsDoc`: add `markdownByDefault`, error handling
parents 926e2305 b106ff14

nixos/lib/make-options-doc/default.nix

+3 −0
Original line number Diff line number Diff line
@@ -40,6 +40,8 @@ 
# `false`, and a different renderer may be used with different bugs and performance

# characteristics but (hopefully) indistinguishable output.

, allowDocBook ? true

# whether lib.mdDoc is required for descriptions to be read as markdown.

, markdownByDefault ? false

}:



let
@@ -152,6 +154,7 @@ in rec { 
      python ${./mergeJSON.py} \

        ${lib.optionalString warningsAreErrors "--warnings-are-errors"} \

        ${lib.optionalString (! allowDocBook) "--error-on-docbook"} \

        ${lib.optionalString markdownByDefault "--markdown-by-default"} \

        $baseJSON $options \

        > $dst/options.json

nixos/lib/make-options-doc/mergeJSON.py

+19 −8
Original line number Diff line number Diff line
@@ -201,19 +201,27 @@ def convertMD(options: Dict[str, Any]) -> str: 
        return option[key]['_type'] == typ



    for (name, option) in options.items():

        try:

            if optionIs(option, 'description', 'mdDoc'):

                option['description'] = convertString(name, option['description']['text'])

            elif markdownByDefault:

                option['description'] = convertString(name, option['description'])



            if optionIs(option, 'example', 'literalMD'):

                docbook = convertString(name, option['example']['text'])

                option['example'] = { '_type': 'literalDocBook', 'text': docbook }

            if optionIs(option, 'default', 'literalMD'):

                docbook = convertString(name, option['default']['text'])

                option['default'] = { '_type': 'literalDocBook', 'text': docbook }

        except Exception as e:

            raise Exception(f"Failed to render option {name}: {str(e)}")





    return options



warningsAreErrors = False

errorOnDocbook = False

markdownByDefault = False

optOffset = 0

for arg in sys.argv[1:]:

    if arg == "--warnings-are-errors":
@@ -222,6 +230,9 @@ for arg in sys.argv[1:]: 
    if arg == "--error-on-docbook":

        optOffset += 1

        errorOnDocbook = True

    if arg == "--markdown-by-default":

        optOffset += 1

        markdownByDefault = True



options = pivot(json.load(open(sys.argv[1 + optOffset], 'r')))

overrides = pivot(json.load(open(sys.argv[2 + optOffset], 'r')))