Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Meta] Gather support for Framework :: Sphinx :: Domain PyPI classifier #11562

Closed
jdillard opened this issue Aug 8, 2023 · 14 comments
Closed

Comments

@jdillard
Copy link
Contributor

jdillard commented Aug 8, 2023

The list of domains in the docs is somewhat outdated and I think it would be useful if we could take advantage of the PyPI trove classifiers and create a Framework :: Sphinx :: Domain, similar to Framework :: Sphinx :: Extension. But first we need to have the classifier approved and created using these guidelines:

  • New Framework classifiers should be created if they are "notable;" and
  • They will be of immediate use to existing projects (in other words, no creating classifiers simply in anticipation of future uses)
    We understand that "notability" is subjective and we'd appreciate help judging that.

As to the other guideline ('immediate use to existing projects'), it's been suggested that

  • Requestors can demonstrate this by providing links to 10 or more existing PyPI projects that have expressed a desire to use the classifier; or
  • Another way to demonstrate this would be to have 10 or more other project maintainers submit comments on the requesting issue about their desire to use the classifier.

If you maintain a Sphinx domain and think a Framework :: Sphinx :: Domain would be useful for helping people find your domain as well as the greater Sphinx ecosystem, please leave a comment expressing interest in using the classifier with a link to the package that you maintain to help with the approval process.

@AA-Turner
Copy link
Member

Note: there are ~200 Framework :: Sphinx :: Extension packages listed on PyPI that match the term "domain".

A

@AA-Turner AA-Turner changed the title [Meta] Gather support for Framework :: Sphinx :: Domain PyPi classifier [Meta] Gather support for Framework :: Sphinx :: Domain PyPI classifier Aug 8, 2023
@AA-Turner AA-Turner pinned this issue Aug 8, 2023
@joeced
Copy link

joeced commented Aug 8, 2023

I'm interested, I maintain the MATLAB Domain at

https://github.com/sphinx-contrib/matlabdomain

See sphinx-contrib/matlabdomain#210

@markstory
Copy link

I can see the additional classifier being helpful to folks looking for domains. 👍. I maintain the php domain

@AA-Turner AA-Turner added this to the some future version milestone Aug 11, 2023
@AA-Turner AA-Turner unpinned this issue Aug 17, 2023
@AA-Turner AA-Turner pinned this issue Aug 20, 2023
@taminomara
Copy link

+1, that'd be useful (author of AntLR4 domain).

@AWhetter
Copy link
Contributor

I can see this being useful. Finding whether a domain exists currently involves using a search engine for something like "graphql sphinx domain" and hoping that brings something up, which might not always be the case for new projects. Alternatively a user could use the unreliable method of searching for packages with a common naming convention like "gqldomain" or "graphqldomain", but there's no guarantee that the naming convention is followed.

So if this classifier existed then I'd make use of it on https://github.com/AWhetter/graphqldomain

@SilverRainZ
Copy link
Contributor

+1 from the any domain.

@Paebbels
Copy link

Paebbels commented Sep 4, 2023

As maintainer of VHDL/VHDLDomain I'm interested.

Framework :: Sphinx :: Extension is nice, but not specific enough.

@danwos
Copy link
Contributor

danwos commented Sep 27, 2023

Also interested in this.
Mostly as a maintainer of Sphinx-Bazel, but also as I'm maintaining an automated list of Sphinx-Extensions, which is based on the Classifiers: https://awesomesphinx.useblocks.com/

@hio
Copy link

hio commented Nov 22, 2023

+1 from erlangdomain.

@cblegare
Copy link

cblegare commented Nov 22, 2023

+1 from sphinx-compendia which is not a domain per se but still a simple API for creating Sphinx domains and structuring arbitrary collections.

EDIT
+1 from sphinx-terraform and sphinx-gherkin

@jdillard
Copy link
Contributor Author

jdillard commented Nov 22, 2023

That makes 10! I created the request to add the Framework :: Sphinx :: Domain classifier here: pypa/trove-classifiers#163

edit: It got accepted and merged! Now just need to wait for the 2023.11.22 release to get merged.

@jdillard
Copy link
Contributor Author

jdillard commented Dec 5, 2023

The new trove classifiers were merged in pypi/warehouse#15012, and I'm fairly sure that was the last step but not 100% sure since it doesn't show up on PyPi if no packages are using it. Would anyone want to test out making a release with the new Framework :: Sphinx :: Domain to confirm it is live?

joeced added a commit to sphinx-contrib/matlabdomain that referenced this issue Dec 16, 2023
As mentioned in sphinx-doc/sphinx#11562, the
``Framework :: Sphinx :: Domain`` should now be available.
joeced added a commit to sphinx-contrib/matlabdomain that referenced this issue Dec 16, 2023
* Added new Sphinx Domain classifier

As mentioned in sphinx-doc/sphinx#11562, the
``Framework :: Sphinx :: Domain`` should now be available.

* Update version in citation
@joeced
Copy link

joeced commented Dec 16, 2023

Confirmed! I released a new version of the MATLAB Domain and it's now listed when searching for Framework :: Sphinx :: Domain:

https://pypi.org/search/?c=Framework+%3A%3A+Sphinx+%3A%3A+Domain

@AA-Turner AA-Turner unpinned this issue Dec 28, 2023
@AA-Turner
Copy link
Member

Closing as the trove classifier now exists!

A

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests