Corrected Image Links

[SinginAlong]

The original image links led to 404 errors. They were missing '/docs', which I have added. Sorry for the unrelated branch name.

[fwkoch]

Hey @SinginAlong - thanks for the contribution!

I suspect you are looking at the raw .rst files rendered in github (let me know if this is a wrong assumption!). There is a conflict between that vs. building the html sphinx docs (which happens relative to the /docs folder). In addition to the image 404s, there's other problems with these pages in github, e.g. https://github.com/gmggroup/omf/blob/dev/docs/content/pointset.rst

However, when we pass these files through sphinx-build (using make docs https://github.com/gmggroup/omf/blob/dev/Makefile#L9-L10) everything resolves and builds nicely: https://omf.readthedocs.io/en/latest/content/pointset.html

It would be great if both github rendering and built docs worked well, but I think that will require a bigger repo restructure, not just updating paths. Does that make sense?

[SinginAlong]

Hey there,

Thanks for the clarification! Your assumption is correct, I was trying to get it to work on github without understanding how that would affect the built files.

It would be nice if github represented those images like the built files. Maybe I'll make a PR to fix github itself ;)

Best, SinginAlong

On Thu, May 27, 2021 at 11:58 AM Franklin Koch @.***> wrote:

External Email

Hey @SinginAlong https://github.com/SinginAlong - thanks for the contribution!

I suspect you are looking at the raw .rst files rendered in github (let me know if this is a wrong assumption!). There is a conflict between that vs. building the html sphinx docs (which happens relative to the /docs folder). In addition to the image 404s, there's other problems with these pages in github, e.g. https://github.com/gmggroup/omf/blob/dev/docs/content/pointset.rst

[image: image] https://user-images.githubusercontent.com/9453731/119877773-aaaaae00-bee6-11eb-902c-83d35f3971ee.png

However, when we pass these files through sphinx-build (using make docs https://github.com/gmggroup/omf/blob/dev/Makefile#L9-L10) everything resolves and builds nicely: https://omf.readthedocs.io/en/latest/content/pointset.html

It would be great if both github rendering and built docs worked well, but I think that will require a bigger repo restructure, not just updating paths. Does that make sense?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/gmggroup/omf/pull/100#issuecomment-849865953, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADNNGEQIMPQTB4YVWGNJ4OTTP2I4RANCNFSM45C6T27A .

-- Best regards, Kyle Everly @.*** 520-903-8145

[SinginAlong]

Closing PR. Updates would have broken built sphinx files