[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-30 Thread leif
Jeroen Demeyer wrote: > On 2016-08-28 18:59, Simon King wrote: >> Is it possible to use "sage -t" on such docs? > > I would guess that the doctesting is *not* affected by the formatting of > the surrounding documentation. AFAIK Sage's doctest parser doesn't care about markup (especially

Re: [sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-30 Thread Jeroen Demeyer
On 2016-08-28 18:59, Simon King wrote: Is it possible to use "sage -t" on such docs? I would guess that the doctesting is *not* affected by the formatting of the surrounding documentation. -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To

[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-29 Thread Sébastien Labbé
For my optional sage package [1], the last time I spent time building its documentation using Sage, I ended up with these command in my makefile, which calls a sphinx makefile: cd docs && sage -sh -c "make html" cd docs && sage -sh -c "make latexpdf" For now, I am not using sage_autodoc

[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-28 Thread Simon King
Hi William, On 2016-08-28, William Stein wrote: > In case you're wondering -- what are "google-style docstrings"? > > http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html > > and > > https://sphinxcontrib-napoleon.readthedocs.io/en/latest/ > > It seems

[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-28 Thread Simon King
Hi Volker, On 2016-08-28, Volker Braun wrote: > On Sunday, August 28, 2016 at 2:30:27 PM UTC+2, Simon King wrote: >> >> Thus, the question remains: How to use the doc builder in order to >> create in SAGE_ROOT/local/share/ the documentation of a pip-installable >>

Re: [sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-28 Thread William Stein
On Sun, Aug 28, 2016 at 6:35 AM, Volker Braun wrote: > On Sunday, August 28, 2016 at 2:30:27 PM UTC+2, Simon King wrote: >> >> Thus, the question remains: How to use the doc builder in order to >> create in SAGE_ROOT/local/share/ the documentation of a pip-installable >>

[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-28 Thread leif
Volker Braun wrote: > On Sunday, August 28, 2016 at 2:30:27 PM UTC+2, Simon King wrote: > > Thus, the question remains: How to use the doc builder in order to > create in SAGE_ROOT/local/share/ the documentation of a pip-installable > module, > > > Unless you plan on eventually

[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-28 Thread Volker Braun
On Sunday, August 28, 2016 at 2:30:27 PM UTC+2, Simon King wrote: > > Thus, the question remains: How to use the doc builder in order to > create in SAGE_ROOT/local/share/ the documentation of a pip-installable > module, Unless you plan on eventually putting the code in Sage I wouldn't use

[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-28 Thread Simon King
Hi Samuel, On 2016-08-27, Samuel Lelievre wrote: > Le samedi 27 août 2016 14:40:26 UTC+2, Simon King a écrit : > > not really answering your question, but just to mention there are > some thoughts on this on the wiki page "Code sharing workflow": > >

[sage-devel] Re: How to use Sage's doc builder off the source tree

2016-08-27 Thread Samuel Lelievre
Le samedi 27 août 2016 14:40:26 UTC+2, Simon King a écrit : > > Hi! > > It has been a long time since I was considering Sage's doc builder. So, > please allow me to ask, since it is conceivable that I missed recent > developments: > > - Assume you have bunch of cython and python files