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

Provide ZIP downloads for MkDocs #1939

Open
marcelstoer opened this issue Jan 17, 2016 · 5 comments

Comments

@marcelstoer
Copy link
Contributor

commented Jan 17, 2016

I know there's no PDF for MkDocs projects (http://docs.readthedocs.org/en/latest/builds.html?highlight=pdf#mkdocs and #1174).

However, why can't there be at least a downloadable HTML bundle? You have to produce those files anyway, right? Or should there be an HTML bundle but my project https://readthedocs.org/projects/nodemcu/ simply isn't configured/working correctly?

@ericholscher

This comment has been minimized.

Copy link
Member

commented Jan 19, 2016

Mkdocs doesn't generate PDF's, so there is no way for us to support this. Feel free to open a bug there to get PDF support.

We could do downloadable HTML of the mkdocs builds, if you want to add support, the code for it is here: https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/backends/mkdocs.py

@marcelstoer

This comment has been minimized.

Copy link
Contributor Author

commented Jan 19, 2016

Mkdocs doesn't generate PDF's, so there is no way for us to support this.

As I said, I know and understand that 😉 There are a number of issues over at MkDocs that circle around that topic but only mkdocs/mkdocs#374 (comment) currently has some momentum. We'll see...

Thanks for the pointer to mkdocs.py. Being familiar with neither your code base NOR Python makes this seem like a daunting task. However, even old dogs are never too old to learn new tricks. In pseudo-code I'd expect something like:

...
invokeMkDocsBuilder(outputDir)
zip = zip(outputDir)
copyFile(zip, 'https://readthedocs.org/projects/' + project + '/downloads/')
...

I'll look into the code and http://docs.readthedocs.org/en/latest/contribute.html#contributing-to-development to see if I think it'll get me somewhere.

@jgrassler

This comment has been minimized.

Copy link

commented Jan 30, 2016

On the subject of PDF generation: mkdocs/mkdocs#374 (comment) yielded a working PDF generator already: https://github.com/jgrassler/mkdocs-pandoc

In a nutshell, it generates a single Pandoc document from the original mkdocs source and uses Pandoc's PDF generator facilities. It may have a few more bugs that need ironing out, but it's at a point where I'd risk exposing it to a somewhat broader user base to trigger all these edge cases I probably haven't thought of :-)

@vlcinsky

This comment has been minimized.

Copy link

commented Oct 12, 2017

Why everybody talks here about PDF when the title asks for ZIP file and explicitly excludes PDF?

Maybe the title is confusing (using two negations is probably the problem). I would propose changing the title to Provide ZIP downloads for MkDocs

@RichardLitt RichardLitt changed the title Why no non-PDF downloads for MkDocs Provide ZIP downloads for MkDocs Oct 14, 2017

@RichardLitt

This comment has been minimized.

Copy link
Member

commented Oct 14, 2017

Thanks @vlcinsky - good point. Changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.