Hi, at work we use Sphinx extensively. For many projects we make use of the ``sphinx-apidoc`` command to have a minimal set of docs. For larger modules with more classes, is has become apparent that the generated docs become hard to follow. The main issue are the section headers for classes. We experimented by adding a simple background-color to the class headers and it was a difference of day and night. Just the fact of adding this header has made the docs a *lot* more readable.
We continued fooling around, adding headers for methods as well. The next idea we had was to make those sections foldable, but that has not yet evolved into real code yet. I *will* pursue this for the docs at work. But I thought this might be something that other people might benefit from. I could just create the theme and put it online somewhere, but first I wanted to see what the thoughts on this list are about adding it to the official sphinx distribution once it's polished enough. I am planning to write the JS part using the google-closure library. Primarily because it lets me organise the code much better. All the work I'm doing in the coming weeks will be put to a sandbox repo. All the work in that repo is currently just a very unorganised bunch of files, which will take shape soon. Once I will have something worth demoing, I will let you know. Any thoughts? The current sandbox: https://github.com/exhuma/sphinx-theme-sandbox -- 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 [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/sphinx-users?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
