On Sun, Aug 28, 2016 at 6:35 AM, Volker Braun <vbraun.n...@gmail.com> 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 putting the code in Sage I wouldn't use Sage > docstring format. E.g google-style docstrings are a better syntax, have > better tooling (sphinx-napoleon), and nicer looking output.
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 to be a cleaner style mainly for INPUTS/OUTPUTS than Sphinx. William > >> >> and how can one have links to the (local copy of the) >> documentation of SageMath? > > > By setting up intersphinx with > local/share/doc/sage/inventory/en/reference/objects.inv, see > http://www.sphinx-doc.org/en/stable/ext/intersphinx.html > > > > > -- > You received this message because you are subscribed to the Google Groups > "sage-devel" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to sage-devel+unsubscr...@googlegroups.com. > To post to this group, send email to sage-devel@googlegroups.com. > Visit this group at https://groups.google.com/group/sage-devel. > For more options, visit https://groups.google.com/d/optout. -- William (http://wstein.org) -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+unsubscr...@googlegroups.com. To post to this group, send email to sage-devel@googlegroups.com. Visit this group at https://groups.google.com/group/sage-devel. For more options, visit https://groups.google.com/d/optout.
