QuantEcon / QuantEcon/quantecon-sphinx-theme
Decide the theme's positioning, then its name
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 0
- Forks
- 0
- Avg merge
- 3h 29m
- Merged PRs (30d)
- 1
Description
The package name quantecon-sphinx-theme was flagged as unsatisfying during the theme evaluation in QuantEcon/lecture-python-programming#475 (closed, never merged), with quantecon-minimal-sphinx-theme offered as one alternative and the list left open.
Why it's a real decision, not bikeshedding. The name has to match the theme's purpose, and the record currently holds two different purposes:
| Source | Stated purpose |
|---|---|
PLAN.md in this repo |
A brand-neutral, general-purpose theme extracting reusable parts of quantecon-book-theme, explicitly "the upstream base that quantecon-book-theme can later inherit from" |
| Comments on QuantEcon/lecture-python-programming#475 | A second QuantEcon theme for non-core lecture series — topic series, contributor series — protecting QE identity by keeping quantecon-book-theme restricted |
These pull the name in opposite directions. If it is the brand-neutral upstream base, a quantecon- prefix is actively misleading to outside adopters and something unprefixed would serve better. If it is the second QuantEcon theme, the prefix is right and the question is only what qualifier follows it — minimal, docs, lite.
Settle the positioning first, then the name follows. This is worth resolving before any release, since the name becomes load-bearing on PyPI, in html_theme, and in the module path src/quantecon_sphinx_theme/ the moment anything depends on it. Nothing depends on it today — no tags, no releases, no downstream users — so renaming is currently free.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read PLAN.md and the discussion on QuantEcon/lecture-python-programming#475 to compare the proposed purposes for this theme. Decide and record whether it is a brand-neutral upstream base or a second QuantEcon theme, then choose a name consistent with that decision; done means the positioning and name are settled before release.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100