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

pdf manual on zenodo #6127

Open
tjhei opened this issue Nov 4, 2024 · 6 comments
Open

pdf manual on zenodo #6127

tjhei opened this issue Nov 4, 2024 · 6 comments
Milestone

Comments

@tjhei
Copy link
Member

tjhei commented Nov 4, 2024

We have uploaded a pdf to zenodo, see https://figshare.com/articles/journal_contribution/ASPECT_Advanced_Solver_for_Problems_in_Earth_s_ConvecTion_User_Manual/4865333 , but our pdf manual is by now probably out of date.

We need to either:
a) make the sphinx doc compilable to a PDF (I tried a long time ago and failed)
b) delete references to the PDF manual (citation page, readme, release)

Thoughts?

@tjhei tjhei added this to the 3.0 milestone Nov 4, 2024
@tjhei
Copy link
Member Author

tjhei commented Nov 4, 2024

There is also sphinx singlehtml mode, that could be archived.

@tjhei
Copy link
Member Author

tjhei commented Nov 4, 2024

sphinx make latexpdf fails due to image formats (svgs) and the resulting .tex document has many, many math formatting errors.

@tjhei
Copy link
Member Author

tjhei commented Nov 4, 2024

singlehtml converted to pdf is not too bad:
https://www.math.clemson.edu/~heister/files/ASPECT%202.6.0-pre.pdf

@tjhei
Copy link
Member Author

tjhei commented Nov 6, 2024

Any thoughts on this? We need to figure this out for the release.

@gassmoeller
Copy link
Member

I would say we use what you posted above (the singlehtml to pdf converted version). We can still try for the next release to get the native pdf support working, but I do not think it has the highest priority. By using readthedocs all of the prior releases are available anyway (e.g. https://aspect-documentation.readthedocs.io/en/v2.4.0/) so that the Zenodo version is purely a way to cite the documentation. I would also be ok with removing all the references to the manual, but it is probably more work that continuing with the singlehtml version.

@tjhei
Copy link
Member Author

tjhei commented Nov 8, 2024

Sounds good. I guess we can put a link to the online version inside the zenodo description as well.
The only annoying part is that this pdf is 78MB big.

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

No branches or pull requests

2 participants