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

Make A troubleshooting guide to Building the textbook #112

Open
eak24 opened this issue Sep 11, 2018 · 2 comments
Open

Make A troubleshooting guide to Building the textbook #112

eak24 opened this issue Sep 11, 2018 · 2 comments

Comments

@eak24
Copy link
Collaborator

eak24 commented Sep 11, 2018

If you look through the failed Travis builds, you'll find that very commonly it is the PDF build that fails. Almost always, that failure is justified, as in the failure is represented by some failed html page displaying. This is because during the PDF build phase, we process the LaTex in house, meaning we'll catch math LaTex errors, whereas during the html building phase, the LaTeX is processed by the mathjax javascript code running on the client's computer. This means that the PDF build (found where?) acts as a LaTeX validator. This guide should include common errors we've made in the past and how to fix them.

@eak24
Copy link
Collaborator Author

eak24 commented Sep 11, 2018

Here's a first list of some useful steps:

  • IGNORE WARNINGS - there will be 100s of warnings. They are not what broke your build. Instead, just pay attention to the errors, designated with a "!". To find it, scroll to the bottom of the build - the error will start with a !.
  • Attempt to find the point in the corresponding html where the error ocurred. Chances are, it will be in or near a math LaTeX block. Use the copied language in the error statement to quickly find the spot in Atom with ctrl-shift-f.

@monroews
Copy link
Collaborator

If no error message is given fatal error, then look through the textbook starting from the last warning. Leftover html from our Markdown days is one likely source of errors. But that should have all been cleared out by now. Badly formatted equations are the other culprit.

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