Skip to content

Add optdef2md.py to generate the GAMS doc option table from optcuopt.def - #31

Merged
0x17 merged 1 commit into
mainfrom
doc-option-table
Nov 18, 2026
Merged

0x17 merged 1 commit into
mainfrom
doc-option-table

Conversation

@0x17

@0x17 0x17 commented Nov 18, 2026

Copy link
Copy Markdown
Member

Adds optdef2md.py, a dependency-free script that turns assets/optcuopt.def into optcuopt_s.md, the option table for a cuOpt page in the GAMS documentation (Solver Manuals). The output uses the same layout as the generated option tables of other GAMS solver links (e.g. HiGHS, COPT):

  • one \subsection CUOPT_gr_<group> per option group, one row per visible option with \anchor CUOPT<name>, range or enum values, and default
  • options documented as (default GAMS ResLim) etc. get a \ref GAMSAO<param> link as default
  • unknown option types or undefined groups abort with an error

CONTRIBUTING.md mentions the script next to the note on optcuopt.def.

Testing

  • python3 optdef2md.py -o optcuopt_s.md: 128 visible options in 4 groups, deterministic output
  • Compared the parsed data with GAMS' optcc reader for all 130 options of optcuopt.def: groups, defaults, bounds and enum values match (only differences: optcc built-ins Help/Echo; the two hidden tolerances are skipped)
  • Doxygen rendering is checked in the follow-up GAMS documentation change

@0x17
0x17 merged commit 72e19b3 into main Nov 18, 2026
6 checks passed
@0x17
0x17 deleted the doc-option-table branch November 18, 2026 13:55
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.

1 participant