Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate a Dash Docset #137

Open
triangulum opened this issue Aug 7, 2019 · 3 comments
Open

Generate a Dash Docset #137

triangulum opened this issue Aug 7, 2019 · 3 comments

Comments

@triangulum
Copy link

triangulum commented Aug 7, 2019

I generally browse programming documentation offline, which makes accessing and searching it much more comfortable. I use Dash on macOS and Zeal on Linux. Dash has docsets for many things (including Python, numpy and astropy) but something that's missing so far is the LSST user guide.

Would it be possible to generate an official LSST "docset" for Dash?

Given that the documentation is Sphinx-based, this should be a streamlined/automatable process using the existing doc2dash framework. The steps are all outlined in the Dash Docset Generation Guide.

This would be a great community resource to have!

@jonathansick
Copy link
Member

Sure, I'll look into this.

@triangulum
Copy link
Author

triangulum commented Aug 22, 2019

Thanks!

As an additional request: it would really be nice to have the Doxygen as a docset too. It's often much more detailed than the Sphinx documentation, and easier to find and browse classes and methods, as well as source code snippets.

@jonathansick
Copy link
Member

We're in the process of sunsetting the Doxygen documentation, so we won't be making a Dash docset of it. The good news is that all the content that was formerly available in Doxygen, including C++ documentation, will be available from the Sphinx documentation once that transition is complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants