SPHINXYGEN(1)

📦
version 1.0.12 · 2 versions
, in fedora 44

✨ SPHINXYGEN — the manual page, but make it cute ✨

okay so bestie, welcome to sphinxygen(1) 💖 this is a General Commands Manual page and it's about to be your new fave little tool, no cap.

🌸 NAME 🌸

sphinxygen — generate Sphinx ReST from Doxygen XML 🦋

like, it takes the Doxygen XML and turns it into Sphinx ReST. that's the whole vibe. iconic behavior honestly.

🎀 SYNOPSIS 🎀

sphinxygen [-hf] [-l lang] [--language lang] index_xml output_dir

look at her. so compact. so powerful. 💅

💜 DESCRIPTION 💜

so sphinxygen is a script (yes, a whole script, doing the most and we love her) that reads an XML description of a C API that was extracted by Doxygen, and then outputs Sphinx markup that describes that API. it's giving translator. it's giving bridge between two worlds. 🌈

the index_xml argument must be the path to a index.xml file that lives in a directory generated by Doxygen. like, that's not optional, that's the requirement, periodt.

the output gets written as several ReST files into output_dir — typically one for each documentation group. so you hand her an XML and she hands you back a whole little family of .rst files 🫶

the options are as follows:

✨ OPTIONS ✨

  • -f, --force — for overwriting of any output files that already exist. like she'll just bulldoze right over them. no hesitation. 💀
  • -h, --help — print the command line options and exit. the "wait what does this do again" button. we've all been there 🙈
  • -l lang, --language lang — Sphinx domain to use. and listen, only the "c" domain is currently well supported, so don't get too adventurous okay? 😭
  • -V, --version — print the version and exit. a little "who am i" moment for the program itself 👑

🔥 EXIT STATUS 🔥

sphinxygen exits with a status of 0, or non-zero if an error occurred.

so: 0 = we ate, everything slayed ✨. non-zero = something went sideways, bestie, go read your terminal 😭

👑 SEE ALSO 👑

go say hi to her too, they're literally besties, they work together, iykyk 💖

🦋 AUTHORS 🦋

sphinxygen was written by David Robillard d@drobilla.net.

and that's the whole page, bestie!! 🌟 this was Sphinxygen 1.0.12, dated Jan 18, 2025 — go forth and generate some ReST, you absolute main character 💅🎀🌸
📦 where this page comes from