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.

Sign up for GitHub

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
Closed

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


Installation
------------
Expand Down