search

scipy / scipy-sphinx-theme

Sphinx theme for SciPy documentation and websites
Other
17 stars 26 forks source link

Mimicking the scipy-sphinx-theme #2

Closed trendelkampschroer closed 10 years ago

trendelkampschroer commented 11 years ago

Hi,

I am working on a python project and the projects sphinx documentation. I'd like to mimic the behaviour of the numpy and scipy documentation in my own documentation in certain aspects.

I am using the numpydoc extension to convert docstrings in numpy/scipy format via sphinx to html.

i'd like to start by modifying one of the built-in sphinx themes, I am using agogo right now.

In a first step I'd like to reproduce one aspect of the scipy-theme. The scipy theme has a really nice html layout for the

Parameters

x : type Some info text

Returns

y : type More info txt

section of function/method docstrings. I'd like to reproduce the extra spacing between the Parameters keyword and the variable name and also the colored box of width Paramters ontop and below of parameters.

Is there an easy way to modify a given theme to reproduce this effect.

Unfortunately I have almost no experiece with html and css so any hint to how and where this is achieved in the scipy-sphinx-theme would be of great help to me.

I apologize for abusing your github issue-list for this inquiry, but to me it seemed to be the best way to contact you.

Tanks,

Benjamin

jorisvandenbossche commented 10 years ago

You can also use this theme instead of trying to mimick it?

trendelkampschroer commented 10 years ago

Hi, thanks a lot for your reply. I'd like to just incorporate the aforementioned effects. Maybe you can tell me how you made the api-docstring formatting look the way it does compared to the standard numpydoc layout.

jorisvandenbossche commented 10 years ago

Sorry, can't help with that then (I didn't made it). But then I advise to look into https://github.com/scipy/scipy-sphinx-theme/blob/master/_theme/scipy/static/scipy.css_t or just in your browser with some developer tools (eg in Firefox Ctrl-Shift I) to look at the css of the elements you are interested in.

pv commented 10 years ago

Please see the CSS source or use Firefox's CSS inspector to see how it's done.

trendelkampschroer commented 10 years ago

HI,

thanks a lot for getting back to me. I'll do as you recommended.

Best,

Benjamin

On 24.11.2013 00:17, Joris Van den Bossche wrote:

Sorry, can't help with that then (I didn't made it). But then I advise to look into https://github.com/scipy/scipy-sphinx-theme/blob/master/_theme/scipy/static/scipy.css_t or just in your browser with some developer tools (eg in Firefox Ctrl-Shift I) to look at the css of the elements you are interested in.

— Reply to this email directly or view it on GitHub https://github.com/scipy/scipy-sphinx-theme/issues/2#issuecomment-29144262.