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

Faker is needed to build documentation #291

Closed
jorti opened this issue Oct 29, 2015 · 3 comments
Closed

Faker is needed to build documentation #291

jorti opened this issue Oct 29, 2015 · 3 comments

Comments

@jorti
Copy link

jorti commented Oct 29, 2015

Hello, I'm trying to package faker into a RPM but I cannot build the docs because faker needs to be already installed.

Is there any way to build the docs without the module faker installed?

Thank you.

+ /usr/bin/make -j8 html
~/build/BUILD/faker-0.5.3/docs ~/build/BUILD/faker-0.5.3
sphinx-build -b html -d _build/doctrees   . _build/html
Making output directory...
Running Sphinx v1.2.3

Extension error:
Could not import extension faker.build_docs (exception: No module named faker.build_docs)
Makefile:53: recipe for target 'html' failed
make: *** [html] Error 1
@fcurella
Copy link
Collaborator

Even if we'd move the code that's in faker.build_docs to somewhere in the sphinx build, we'd still need access to the faker module because we need to introspect faker in order to generate examples of the providers.

It might work to temporarily include the directory containing faker in the PYTHONPATH, something like:

PYTHONPATH=~/build/BUILD/faker-0.5.3 /usr/bin/make -j8 html

@jorti
Copy link
Author

jorti commented Oct 29, 2015

Thanks for the explanation

@jorti
Copy link
Author

jorti commented Oct 30, 2015

It has worked. This is what I use:

pushd docs
PYTHONPATH='..' /usr/bin/make -j8 html
popd

Thank you!

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

No branches or pull requests

2 participants