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

Incorrect build documentation due to identical file names of examples #2250

Closed
Tracked by #2244
yvonnefroehlich opened this issue Dec 15, 2022 · 1 comment · Fixed by #2260
Closed
Tracked by #2244

Incorrect build documentation due to identical file names of examples #2250

yvonnefroehlich opened this issue Dec 15, 2022 · 1 comment · Fixed by #2260
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@yvonnefroehlich
Copy link
Member

It seems like it is not allowed by Sphinx-Gallery that two examples have identical filenames, even when they are saved in different folders. Currently, this is the case for:

When running make html to build the documentation locally, the following warning occurs:

WARNING: Duplicate example file name(s) found. Having duplicate file names will break some links.
List of files: ['../examples/get_started/contour_map.py']

According to this the documentation for the tutorial is wrongly build:

Thus, we have to rename one of these two example files.

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Dec 15, 2022
@yvonnefroehlich yvonnefroehlich added this to the 0.8.0 milestone Dec 15, 2022
@seisman
Copy link
Member

seisman commented Dec 18, 2022

Ping @willschlitzer, author of the two examples .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants