chris wuthrich wrote: > > i have some questions and suggestion on the RestructuredText. I am a > ReST-newbie and so maybe these things have been discussed before. > > * In one of my files i have a line "power_series = series". This > produces the full docstring of series to appear twice in the > documentation, once under series and once under power_series. How can > I exclude the alias ? > > * Generally I am very happy with the outputs of the documentation > using sphinx. But there are some improvement that one could think > about. For instance I think there are too many different fonts used, > that is a bit ugly. More importantly I think that the examples and the > warnings are more emphasized than the actual command that is > documented. Also the commands and not well-seperated. To someone who > is not used, this might look confusing. Of course, I have absolutely > no idea if this can be changed or not. > > * The docstrings become much longer now that we have to add > additional empty lines. This is not very nice when using foo? or tab- > completion in the notebook. Also the `` `` are annoying there. Is it > not possible that the printing of the docstring there is simplified ?
Soon we will have html documentation in the notebook, so this won't be an issue there. On a different note, can we change the background color of examples? In my opinion, that green is just a bit too strong. It's also hard to read the blue text in strings against the green background. (After playing with it for a while) I propose a soft light yellowish off-white color, like #fffff4. The syntax highlight colors stand out better, and the whole thing is easier to read. Plus, the barely-yellow color matches nicely with the blue-green of the titlebar, etc. Thanks, Jason --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to sage-devel-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
