stb(1)

📦
version 0.3.2 · 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

✨ stb(1) — okay bestie, let's build a Sphinx theme 💅

So like. This is the manual for stb, from the General Use Manual section of the docs. Welcome, you're gonna love it here 🫶

💖 NAME 💖

stb — a tool for authoring Sphinx themes with a simple (opinionated) workflow. And yes, "opinionated" is doing heavy lifting there, but trust, it's a good opinion.

🌸 SYNOPSIS 🌸

stb [OPTIONS] COMMAND [ARGS]...

That's it. That's the whole incantation. options, then a command, then whatever args that command wants. Periodt.

🦋 DESCRIPTION 🦋

stb is the command-line bestie for sphinx-theme-builder — a tool for authoring Sphinx themes with a simple (opinionated) workflow. Basically it exists so that making Sphinx themes is actually... fun?? Instead of a whole thing. It's litchrally designed to make writing Sphinx themes easier, and it ate, no cap.

Here's what you get, in bullet form because we're organized in this house:

  • simplified packaging experience 💅
  • simplified JavaScript tooling setup ✨
  • development server, with rebuild-on-save and automagical browser reloading 🔥 (yeah. automagical. not a typo. that's the vibe.)
  • consistent repository structure across themes 🎀

It's giving "I have a system and the system is cute". Lowkey iconic, highkey useful.

👑 OPTIONS 👑

  • --help — shows this message and then dips. The classic. 🫶

🌈 COMMANDS 🌈

  • compile — compile the current project's assets. So, like, do the thing with what you've already got. Let's gooo.
  • new — create a new project. Fresh start, blank canvas, main character energy. 🦋
  • npm — interact with the npm that's available in the environment. It's the npm, from the environment, not some random npm off the street. iykyk.
  • package — generate Python distribution files. Time to ship it. 📦✨
  • serve — serve the provided documentation, with livereload on changes. Change a file, watch the browser go brrr. This one is the bestie command, fr fr. 💖

💜 AUTHORS 💜

Written by Pradyun Gedam</> <mail@pradyunsg.me> — a real one, we stan. 🎀

This manual page was written by Bo YU</> <tsu.yubo@gmail.com> for the Debian project (but may be used by others). Sharing is caring, bestie, no gatekeeping here. 🫶

okay so that's the whole page!! no skipping, no secrets, we went through every single bit of it. go forth and make themes, you absolute legend. 🌟

And for the cute sign-off: this is all about version stb-0.2.0b2, dated 01 April 2024. Yes, April Fools' Day, and no, the manpage is not a joke. 🍓 Slay, bye!! 💜

📦 where this page comes from