Ask Your Question

Offline docset for SageMath

asked 2018-05-25 21:20:42 +0200

petRUShka gravatar image

updated 2018-06-02 18:30:46 +0200

There are plenty of offline documentation tools like Zeal (Linux, MacOS, Windows), Dash (MacOS) and dasht (for terminal and with Vim integration). Most of them support Dash format of offline docs. There are hundreds of pre-generated docsets (including Python) and even more but Sage docset is missing.

There is a tool for generating python docset: doc2dash. It supports two doc formats: Sphinx and pydoctor. Unfortunately I'm not familiar with either of them neither with Sage docs.

So my question is: how to create SageMath docset with doc2dash? My goal is to have Sage offline documentation with editor integration.

edit retag flag offensive close merge delete



Sage offline documentation is already available as html and optionally pdf. It is produced with Sphinx, so if you are looking for the "Dash" format, maybe is the right tool. What exactly are you looking for? What does "editor integration" mean?

John Palmieri gravatar imageJohn Palmieri ( 2018-06-02 23:13:02 +0200 )edit

@john-palmieri, by editor integration I meant something like vim-integration mentioned in first paragraph.

Possible doc2dash is a good tool, but I couldn't make some good of it with sage. Could you please give some hints?

petRUShka gravatar imagepetRUShka ( 2019-02-23 22:56:56 +0200 )edit

1 Answer

Sort by ยป oldest newest most voted

answered 2019-02-25 23:14:07 +0200

updated 2019-02-26 01:26:55 +0200

From the main Sage directory: running doc2dash local/share/doc/sage/html/en/reference with appropriate other arguments (like -A on a Mac, maybe --name Sage, etc.) produces a usable Dash docset.

You could presumably also change "reference" at the end to "tutorial" or various other directories for other parts of the Sage documentation.

edit flag offensive delete link more


Thanks! For me it works with command doc2dash /usr/share/doc/sage/html/en/reference -n Sage -i /usr/share/sage/ext/images/sagelogo.png -d docsets

petRUShka gravatar imagepetRUShka ( 2019-07-29 00:25:28 +0200 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

1 follower


Asked: 2018-05-25 21:20:42 +0200

Seen: 877 times

Last updated: Feb 26 '19