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

Image duplication for sphinx docs required #161

Open
gomezzz opened this issue Mar 3, 2023 · 0 comments
Open

Image duplication for sphinx docs required #161

gomezzz opened this issue Mar 3, 2023 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@gomezzz
Copy link
Collaborator

gomezzz commented Mar 3, 2023

Issue

Problem Description

Right now, the images in the readme.md have to also be in the docs folder for the paths to be solved correctly when generating the docs with sphinx.

Expected Behavior

One copy of the images should be fine.

What Needs to be Done

Find some way to make sphinx search the repo root not only the docs folder. or alternative find mutually compatible path where to store the images.

How Can It Be Tested or Reproduced

Look at readme on github and docs online or locally via make html in the docs folder.

@gomezzz gomezzz added bug Something isn't working documentation Improvements or additions to documentation labels Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant