sphinx-codeautolink VS Zundler

You can try the live demo on RTD and have a look at our source on GitHub. Lemme know what you think if you decide to try it out, especially if you run into any problems!

Documentation, PyPI, GitHub

A live demo is available on RTD, and I just released the first beta on PyPI. If you'd like to check development status, we're on GitHub.

A Sphinx extension for auto-linking code to reference documentation! Meaning that every time you click lib.func() in a code block, you get taken to reference documentation. I was baffled that this doesn't exist yet and I really think I'm onto something :D A few improvements left until I release the first beta.

I fully agree with the author's "I want to replace PDF" sentiment.

It's true that running code in the document has some downsides, but the vast majority of people does it all the time in their browsers. And it comes with tremendous upsides. Just imagine large amount of data presented in interactive tables which can sort, filter and export or interactive graphs inside the document. We already use HTML+JS so much, why should we stop at documents? Yes, they can't be printed, but in my observation less and less people even own a printer these days, and I see no reason why this trend should not continue. I bet the future will be mostly living, interactive documents.

It's funny that I just mentioned this in the other thread [1], but I also felt that there is a need for a format that is self-contained and widely supported by standard software (by which I mean browsers). A well-specified open format would be great, but until then I tackled the self-containedness problem with JS and wrote a Python script that zips and bundles all assets and embeds them as a SPA into one HTML file [2]. The focus is on Sphinx docs but it should work in general with all distributed HTML docs.

[1] https://news.ycombinator.com/item?id=39138444

[2] https://github.com/AdrianVollmer/Zundler

One of the selling points of PDF is that it is a single self-contained file. I found this lacking in Sphinx and wrote an extension for it to zip and bundle the assets into a single HTML file: https://github.com/AdrianVollmer/Zundler

Also works with HTML documents produced in other ways.

I have used my own format, resume.json and recently restructuredText. I put both resume.json and the restructuredText as a github gist. My biggest thing is that I don't want to mess around with the style of layout and let other people design a theme. I have been using the sphinx plugins docxbuilder, sphinx-design (for a dropdown option that I kinda thought would be cool), and finally Zundler for an all-in-one HTML file.

So I wrote a tool in Python and JavaScript that attempts to solve this by embedding everything in one singular self-contained HTML file: Zundler