Le 31/01/2019 à 14:01, E. Madison Bray a écrit :
On Tue, Jan 29, 2019 at 9:38 PM Nathan Dunfield <nat...@dunfield.info> wrote:
Vincent,
Imagine I have a Python module, typically hosted on PyPI and depending
on SageMath, that provides documentation in some form (e.g. a pdf file,
a sphinx repo, etc).
1) When a user performs `sage -pip install X`, should the documentation
be compiled and installed?
I can tell you what we do with SnapPy, which has both Sphinx-generated docs and some PDF files.
When building the sdist tarballs and wheels for posting on PyPI, we use Sphinx to compile the docs
into HTML and then put the resulting HTML files as well as a few random PDFs into the Python
package as "package data". There are convenience functions such as
"spherogram.pdf_docs()" which open the docs in a webrowser or pdfviewer as appropriate.
As we support vanilla Python as well as SageMath, we can't assume that Sphinx is installed.
+1 to this approach. It's definitely easier if the docs are
pre-generated by the developer and included in the source tarball.
This is definitely easy and doable. But what should be done with it by
default? Would you advice to do as Nathan did with Snappy: copy
the documentation inside the installed Python package?
--
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.
