Remove finufft-manual.pdf from git repo

[janden]

Right now, the manual is stored as a PDF in the repo. Given that this PDF weighs in about 2.4 MB and is replaced each time we do a release, this will make our git history quite large (right now, my .git folder is at 44 MB). Since the website already contains all the documentation, maybe we can remove this file from the repo? Alternatively, there may be a solution to host the PDF on the website instead (we could probably automate the process as part of the CI).

[ahbarnett]

Hmm, ok, maybe. I wanted a simple clone (or tarball) to include the manual, for non-git people. But hosting in the readthedocs would be ok too, and the README.md has a URL. I don't know how to auto-upload that (I set it up so make docs does everything apart from the triggering of readthedocs which is automatic; would like to keep it that way, so maybe a wput command in the make task?)
This 8-yr-long unresolved convo suggests it will not be easy:
readthedocs/readthedocs.org#1083
Any ideas welcome.

[lu1and10]

Hmm, ok, maybe. I wanted a simple clone (or tarball) to include the manual, for non-git people. But hosting in the readthedocs would be ok too, and the README.md has a URL. I don't know how to auto-upload that (I set it up so make docs does everything apart from the triggering of readthedocs which is automatic; would like to keep it that way, so maybe a wput command in the make task?)
This 8-yr-long unresolved convo suggests it will not be easy:
readthedocs/readthedocs.org#1083
Any ideas welcome.

Not sure this is related to pdf format for readthedocs

One can put format tag in the configure file .readthedocs.yml to make readthedocs to generate pdf file
https://docs.readthedocs.io/en/stable/config-file/v2.html#formats

Then there will be a pdf url from readthedocs, something like https://buildmedia.readthedocs.org/media/pdf/finufft/latest/finufft.pdf
As discussed in https://stackoverflow.com/questions/50425740/how-to-find-the-pdf-version-of-a-read-the-docs-project

[lu1and10]

I changed the readthedocs configure file to build more formats. Available formats are list here now: https://readthedocs.org/projects/finufft/downloads/ and pdf link, https://finufft.readthedocs.io/_/downloads/en/latest/pdf/

…

On Fri, Jun 10, 2022 at 11:26 AM Alex Barnett ***@***.***> wrote: Hmm, ok, maybe. I wanted a simple clone (or tarball) to include the manual, for non-git people. But hosting in the readthedocs would be ok too, and the README.md has a URL. I don't know how to auto-upload that (I set it up so make docs does everything apart from the triggering of readthedocs which is automatic; would like to keep it that way, so maybe a wput command in the make task?) This 8-yr-long unresolved convo suggests it will not be easy: readthedocs/readthedocs.org#1083 <readthedocs/readthedocs.org#1083> Any ideas welcome. — Reply to this email directly, view it on GitHub <#221 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMXDUKGGSIARNGKR22KAUS3VONNCVANCNFSM5YF6ZTMA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[janden]

Wow that's great… So we could just link to that from our README for people who visit the GitHub repo?

[ahbarnett]

Yes, this is great, Libin! Thanks. I can close this up. Best, Alex PS I need to change the docs/README to reflect our new situation; doing now.

[ahbarnett]

Done. Complete rewrite of docs/README. Simplified make docs to only build what sphinx needs, no longer to run sphinx locally.