Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Relative paths of example directories not relative to doc root #50

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

Jump to bottom
Closed
florian-wagner opened this issue Aug 5, 2015 · 4 comments
Closed

Relative paths of example directories not relative to doc root #50

florian-wagner opened this issue Aug 5, 2015 · 4 comments
Milestone
Release v0.1.8

Comments

@florian-wagner
Copy link

I have asked something similar in the closed issue #40, but I still think there is something wrong with the paths. Shouldn't they be relative to the documentation source (i.e. the location of conf.py) rather than relative to the location where sphinx-build is called?

cd ~/tmp
git clone https://github.com/sphinx-gallery/sphinx-gallery
sphinx-build -q sphinx-gallery/doc html_output # does not work
cd sphinx-gallery/doc && sphinx-build -q . html_output # works fine

The output of the first sphinx-build call is:

WARNING: 'default' html theme has been renamed to 'classic'. Please change your html_theme setting either to the new 'alabaster' default theme, or to 'classic' to keep using the old default.

Exception occurred:
  File "/usr/lib/python3.4/os.py", line 237, in makedirs
    mkdir(name, mode)
PermissionError: [Errno 13] Permission denied: '../../../examples'
@lesteve
Copy link
Member

lesteve commented Aug 5, 2015

Shouldn't they be relative to the documentation source (i.e. the location of conf.py) rather than relative to the location where sphinx-build is called?

I think the convention we are following is the latter, the main reason for that is that we are always building the documentation from the doc folder as far as I know. Do you see something especially wrong with that ?

@florian-wagner
Copy link
Author

sphinx itself does allow to build the documentation everywhere and I think sphinx-gallery should not break this functionality.

It is very useful to separate the source from compiled files including the docs. Always building the documentation in the source tree itself is especially annoying when calling the status of your version control, as a lot of untracked files are generated.

@lesteve
Copy link
Member

lesteve commented Aug 5, 2015

Fair points. To be brutally honest, I don't see anything happening in near future on this front, just because these issues are not important enough for our use cases. Of course PRs are more than welcome!

FWIW, we are generally building documenation using the Makefile in doc rather than directly issuing sphinx commands.

@emmanuelle emmanuelle mentioned this issue Mar 28, 2016
Closed
@Titan-C Titan-C mentioned this issue Jul 23, 2016
Closed
@Titan-C Titan-C added this to the Release V0.1.4 milestone Aug 3, 2016
@Titan-C Titan-C modified the milestones: Release V0.1.5, Release V0.1.4 Sep 4, 2016
@Titan-C Titan-C mentioned this issue Dec 21, 2016
Merged
@Titan-C Titan-C modified the milestones: Release v0.1.8, Release V0.1.6 Jan 3, 2017
@Titan-C
Copy link
Member

Titan-C commented Jan 17, 2017

This is fixed in #190

@Titan-C Titan-C closed this as completed Jan 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Release v0.1.8
Development

No branches or pull requests
3 participants
@Titan-C @lesteve @florian-wagner