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

Fix location of image in sasview-api docs #120

Closed
wants to merge 1 commit into from

Conversation

llimeht
Copy link
Contributor

@llimeht llimeht commented Nov 1, 2017

Updating the location of the BatchGridClass.png image permits sphinx to generate the PDF once more. (A slightly prettier relative path might also be possible...)

Copy link
Contributor

@pkienzle pkienzle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't had a chance to look into implementation details, but we should not be encoding the structure of the sphinx doc tree into the documentation for the individual perspectives. If one perspective is referencing media from another perspective, we just need to make sure that we walk up the tree enough that we can walk down to the sister perspective. Maybe removing the parent reference .../user would accomplish the same thing?

@pkienzle
Copy link
Contributor

pkienzle commented Nov 3, 2017

I'm not seeing the problem with the latex builds, and the path seems correct for the location of the files within the source-temp tree created by the build_sphinx.py. Please explain why you need this patch a little better, or close this pull request without merging.

Note that for building the docs, make does not work. You need to use build_sphinx.py.

Note also that the docs incorporate some of the docs for sasmodels and bumps, so they need to be in sister directories when the build starts, with docs already built for those packages. I can see this causing difficulty for your Debian build if you are treating sasmodels, bumps and periodictable as separate debian packages (sorry!) but we would otherwise not be able to build a coherent set of documentation for standalone sasview.

@llimeht
Copy link
Contributor Author

llimeht commented Nov 4, 2017

This looks like it was a side-effect of trying to deal with the difficulties of stitching together the 3 different documents. Sorry for the noise.

@llimeht llimeht closed this Nov 4, 2017
@llimeht llimeht deleted the tmp/sasview-api-image branch November 4, 2017 13:13
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

Successfully merging this pull request may close these issues.

None yet

2 participants