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

Build documentation fails #55

Open
saltynexus opened this issue Oct 3, 2019 · 2 comments
Open

Build documentation fails #55

saltynexus opened this issue Oct 3, 2019 · 2 comments

Comments

@saltynexus
Copy link

I tried to build the documentation under /gpusph/docs/user-guide using "make" and it fails. Are these documents actually maintained? There is clearly missing figures. If they are not maintained, then remove them from the release to avoid confusion.

I know there are documents on the main homepage, but the ones in the source code appear to be more thorough?

@Oblomov
Copy link
Contributor

Oblomov commented Oct 3, 2019

We try to keep the documentation updated (albeit with a lower priority than the code itself), but the issue you're having is most definitely due to the missing figures. (We try not to ship binary data with git because the tool isn't really designed to handle it.) I'm keeping this issue open, as a general reminder. The things we need to do are:

  • package the figures in an easy-to-retrieve way (like the meshes for the default test problems);
  • update the documentation on the website;
  • look into a way to an automatically update the documentation on the website, splitting the one referring to master from the one referring to next.

@saltynexus
Copy link
Author

Any possibility to expedite this? In my opinion "master" should not be made public without proper updated documentation. How do I know if the errors I encounter are bugs/issues or not if I don't know how to run the software as instructed by developers? Just saying.

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