#sphinx-doc

MVXA: near as i can tell you can break the line with a backslash, but you don't indent the next line. http://stackoverflow.com/questions/14414878/how...

hello, I use sphinx to create the documentation for an API I’m using the http domain, it works fine in for doc written in my .rst files but not for docstrings that I get using autodoc - can someone see why?

ok I solved my problem, I had started the directive .. http:get:: in the rst file before calling autodoc, now I have the complete .. http:get:: block in the docstring and it works

[02sphinx] 07shimizukawa pushed 031 commit to 03stable [+0/-0/±1] 13https://bitbucket.org/birkenfeld/sphinx/commits/

[02sphinx] 07shimizukawa <shimizukawa@gmail.com>; 030a9e1d8 - fix documentation for extension development tutorial. Closes #1624. Thanks to dkeeney_fastacash.

I am trying to get bengali in latexpdf output from sphix, any tips on how to handle this?

is there a neat live-reload extension available for sphinx which will also update the view in the browser?

MVXA: You mean re-build when files are changed but also push the update to the browser somehow?

yes

or instructing the browser to refresh the view from the newly generated html file

i'm growing somewat tired of the edit, make docs, f5 cycle

Have you looked for tools to run a command when watched files change?

that wouldn't cover the browser part, would it?

You could combine that with a browser greasemonkey script that periodically refreshes.

uhm

Pushing a refresh down to the browser sounds pretty complex.

and outside the general sphinx use case.

oh well, it would be just a candy

Suffice to say I don't know of one, so if you didn't find one I don't know that I'd find anything either.

okay, thanks though

the usual flow looks like writing some passages and then see how it ends up on the browser, reading it again there, fixing some typos, wording, etc. and ensure it also appeals to the eye. Easing the last step would be nice but if it can't be had what so ever … sphinx is great enough

hi

I have a strange sphinx docstring question

I have a link that's well beyond 72 characters that PEP8 specifies

what's the best way to go about this?

seems like backslash it is http://stackoverflow.com/questions/14414878/how...

mrshu: IIRC a line continuation can cause display whitespace discontinuities in some renderers, such as the man page one.

sdough: hmm, ok

sdough: what do you suggest then?

I don't know if it's worth bothering about in your use case. I broke PEP8 and left the line long. I think https://pypi.python.org/pypi/sphinxcontrib-napo... might allow breaking lines without those problems?

I agree with the last line of that SO answer: "Also, PEP8 is a guide, not a law - this seems a (rare) case where it's ok to ignore it."

PEP8 itself gives "But most importantly: know when to be inconsistent -- sometimes the style guide just doesn't apply. When in doubt, use your best judgment. Look at other examples and decide what looks best. And don't hesitate to ask! "

yeah, that's probably true

thanks sdough!

mrshu: Happy to help!