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

rst paths must be relative to the docs/ dir #729

Closed
wants to merge 1 commit into from

Conversation

asmacdo
Copy link
Member

@asmacdo asmacdo commented Jan 12, 2024

No description provided.

Copy link

codecov bot commented Jan 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (555a758) 81.97% compared to head (65a05c8) 81.97%.
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #729   +/-   ##
=======================================
  Coverage   81.97%   81.97%           
=======================================
  Files          41       41           
  Lines        4149     4149           
=======================================
  Hits         3401     3401           
  Misses        748      748           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -53,7 +53,7 @@ into structured directory layouts.

Heudiconv can be inserted into your workflow to provide automatic conversion as part of a data acquisition pipeline, as seen in the figure below:

.. image:: figs/environment.png
.. image:: ../figs/environment.png
Copy link
Member

Choose a reason for hiding this comment

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

nope -- it is in the root so cannot ../. For the documentation where we link via ../README.rst which I guess causes the issue you are trying to solve... but there there is a symlink

❯ ls -ld docs/figs
lrwxrwxrwx 1 yoh yoh 8 Jan 12 17:30 docs/figs -> ../figs//

so likely should just work.

So what problems are you trying to solve???

Copy link
Member Author

Choose a reason for hiding this comment

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

This was my initial investigation into what was broken about the docs build. You're correct, this broke the root README.

Christian fixed this another way today, so I'll close

@asmacdo asmacdo closed this Jan 12, 2024
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.

2 participants