Survey of Sphinx extensions

[Komiya Takeshi]

Hello,

I made a list of sphinx extensions (for presentation at SphinxCon JP 2014).

Currently, it includes 230 extensions.

http://sphinxext-survey.readthedocs.org/en/latest/

It is based on searchs from PyPI and Googles (mainly github, gist and bitbucket).

The extensions are classified into 18 categories.

- autodoc

- builders

- changelog/version-control

- data-sources

- domains

- enhancement

- execute/result

- images

- integrations

- metadata

- multimedia/web-services

- roles

- search

- thesis/latex

- utilities

- website/blogs

Please use it to search extension if you like.

BTW, for now,  it is too hard to find and add new extensions to the list,

because the list is made manually.

If you have good idea to follow new extensions, please let me know.

Thanks,

--

Takeshi KOMIYA

[Kevin Horn]

Very cool project, though I notice that the author of the traclinks extension is incorrect.

(Hint: I'm the author ;) )

Also, there's an extension for linking PyDoctor docs, though it doesn't have a proper home yet.  Right now it can be found in both the PyDoctor and Twisted repositories, which is...not ideal.

I'd really like to see a convention in the community of having PyPI metadata (keyword?  trove identifier?) that marks a package as a Sphinx extension, so that lists like this could be generated at least partially automatically.  Has anyone out there given any thought to this kind of thing?

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

--
--

Kevin Horn

[Eric Holscher]

This is really neat. I would love if something like this got included in the actual Sphinx documentation itself. It's hard to find extensions in the wild, and especially hard to judge the quality if multiple extensions do similar things.

I would also love to see an opinionated guide that suggests the best extensions for a task as well. For Read the Docs, we've been looking at trying to document and "bless" certain of the autodoc tools for specific languages. I really want Sphinx to grow outside of the Python world, and making sure good autodoc solutions exist for other popular languages would be a huge step.

Cheers,

Eric

[Georg Brandl]

Really neat indeed. At the very least a prominent link should be added.

Otherwise +1 on everything Eric said.

Georg

> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email
> to sphinx-users...@googlegroups.com

> <mailto:sphinx-users...@googlegroups.com>.

> To post to this group, send email to sphinx...@googlegroups.com

> <mailto:sphinx...@googlegroups.com>.

[yarko]

I've had no more time than to casually, quickly think about this - maybe someone else will take a quick peek:

- I wondered if a custom instance of djangopackages would serve this well, both as a search tool, and a way of registering new extensions;

https://github.com/pydanny/djangopackages  - in case someone wants to see if it would be suited, would take much to adapt for a sphin-extensions sort of instance;