Offline docset for SageMath

asked 2018-05-25 14:20:42 -0600

petRUShka gravatar image

updated 2018-06-02 11:30:46 -0600

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

Comments

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 https://pypi.org/project/doc2dash/ is the right tool. What exactly are you looking for? What does "editor integration" mean?

John Palmieri gravatar imageJohn Palmieri ( 2018-06-02 16:13:02 -0600 )edit