Hellooooooo everybody !!

I wrote to your mailing list some time ago about the same problem. We still 
have not solved it and with time it actually grows worse and worse :-)

I am contributing to the software Sage (http://www.sagemath.org/), which 
heavily uses Sphinx (thanks a *LOT*. This software is just totally great, I 
have no idea which kind of doc we would have otherwise). 

Now our problem is that the pages generated by sphinx are.... Quite LONG. 
One example of the hell it has become :
http://www.sagemath.org/doc/reference/sage/graphs/generic_graph.html

Well... Our functions are all there, but it is quite difficult to find the 
one you are looking for. You can still do a CTRL+f, that's true. But now it 
is totally impossible to quickly check the list of methods.
Besides, the page is so crowded that it is, first, long to load, and also 
that the documentation of a specific function is harder to read when you 
have thousands of them around.

Some time ago, Minh generated a version of Sage's doc with "one page per 
function" :

http://mvngu.googlecode.com/hg/onepage/graphs/generic_graph.html

This was great, but two problems remained :
- To generate this documentation Minh had to write a custom script [1] to 
generate this documentation
- Generating this documentation took a twice the usual time

I thought a bit about this problem, and I have to say that I found no good 
answer. I was wondering whether using some Javascript in the doc may make 
it nicer, but I also worried about keeping our documenatation indexed by 
Google, in such a way that by typing a few words in google we would be 
redirected toward our doc -- and at the right place.

Well.. As I have no idea how to fix this, and as I know nothing about how 
Sphinx works, I thought it'd be worth writing to this forum once again. 
Perhaps somebody here will have "the perfect idea that makes it all work" 
:-)

Thaaaaaaaaaankssssssssssss !

Nathann

[1] https://groups.google.com/d/topic/sage-devel/ZcJbtNLpSkU/discussion

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To view this discussion on the web visit 
https://groups.google.com/d/msg/sphinx-dev/-/lMLnzWNkJYQJ.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to