Skip to content

Build process leaves out important detail - cwd #890

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

Closed
jaraco opened this issue Aug 16, 2014 · 3 comments
Closed

Build process leaves out important detail - cwd #890

jaraco opened this issue Aug 16, 2014 · 3 comments
Labels
Community Effort Good First Issue Good for new contributors Improvement Minor improvement to code Sprintable Small enough to sprint on

Comments

@jaraco
Copy link
Contributor

jaraco commented Aug 16, 2014

In the RTD docs, the build process suggests that all RTD does in invoke build-sphinx in a checkout of the project, but there appears to be an implicit step where it changes directory to docs/ first.

This issue led to this pull request in setuptools.

I suggest RTD should document this implicit step or not require that step through a technique such as suggested in #889.

@ericholscher
Copy link
Member

Agreed, the build process is definitely not documented well. However, Sphinx generally is run from the directory with the conf.py file in it -- which is what we do. So I think this is a pretty standard usage, but should be explicitly documented.

+1 on updating the docs.

@frontendphil
Copy link

I currently run into problems because of this behaviour. I tried to circumvent an i18n issue with images by having multiple conf.py files. One for each language. Those would then always include the regular conf.py and overwrite what's needed. This works great then doing a sphinx-build -c lang_dir/ . _build/html But this fails completely when you first go into lang_dir and execute the sphinx-build from there.

The main problem is of course, that there seems to be no really good way to have i18n for images. That's why my approach is having images in language directories and copy the correct images to a general directory before the build starts. If there is any better way to fix this, I'm open for suggestions.

@ericholscher
Copy link
Member

This should be fixed in #1524 -- our build process output is now much more explicit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Effort Good First Issue Good for new contributors Improvement Minor improvement to code Sprintable Small enough to sprint on
Projects
None yet
Development

No branches or pull requests

4 participants