Naming a sphinx-doc theme: python-sphinx_py3doc_enhanced_theme or python-sphinx-theme-py3doc-enhanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

Recently I opened a review [1] for a new sphinx theme:
py3doc_enhanced_theme [2]

The upstream name is sphinx_py3doc_enhanced_theme, so in my opinion,
the the package should be named python-sphinx_py3doc_enhanced_theme.
Furthermore, there's another sphinx theme with underscores in its
name: python3-sphinx_rtd_theme. So I find it logical that the package
is named this way.

However, the reviewer (Zbigniew Jędrzejewski-Szmek) pointed out that:

- Dashes are preferred (See the guidelines [3])
- Most themes are named with this pattern: python-sphinx-theme-<name>
Therefore, it would be consistent to name the package: python-sphinx-
theme-py3doc-enhanced and I think that's a good point.

A middle ground would be to use provides so the package can be
installed with both names, but that leaves the question about the
"main" name unresolved.

Any thoughts?

BTW, I though there was a wiki page about packaging sphinx themes but I
can't find it out. Does it ring a bell to anyone?

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1367699
[2] https://pypi.python.org/pypi/sphinx_py3doc_enhanced_theme
[3] https://fedoraproject.org/wiki/Packaging:Naming?rd=Packaging:Naming
Guidelines#Separators

Regards,
-- 
Julien Enselme
http://www.jujens.eu/

Attachment: signature.asc
Description: This is a digitally signed message part

--
devel mailing list
devel@xxxxxxxxxxxxxxxxxxxxxxx
https://lists.fedoraproject.org/admin/lists/devel@xxxxxxxxxxxxxxxxxxxxxxx

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [Fedora Announce]     [Fedora Kernel]     [Fedora Testing]     [Fedora Formulas]     [Fedora PHP Devel]     [Kernel Development]     [Fedora Legacy]     [Fedora Maintainers]     [Fedora Desktop]     [PAM]     [Red Hat Development]     [Gimp]     [Yosemite News]
  Powered by Linux