geopyspark icon indicating copy to clipboard operation
geopyspark copied to clipboard

Make necessary changes for `make html` docs target

Open jpolchlo opened this issue 7 years ago • 6 comments

From a reasonably fresh install, from the docs dir, make html fails due to needing sphinx, sphinx-rst-theme, nbsphinx, and pandoc. There should be a requirements.txt in that folder or some make target to add the needed packages.

jpolchlo avatar Aug 31 '17 14:08 jpolchlo

There is also some suggestion that the nbsphinx dependency should be eliminated, though perhaps that should be a separate issue.

jpolchlo avatar Aug 31 '17 14:08 jpolchlo

@jpolchlo is this issue still open,if yes could you assign it to me?

bhavybarca avatar Oct 17 '18 12:10 bhavybarca

Hey @bhavybarca! This issue is still open, and I'd be happy to assign it to you.

jbouffard avatar Oct 17 '18 14:10 jbouffard

Actually, I'm not sure if I can assign you to this issue. However, we'll make sure that no one else picks it up.

jbouffard avatar Oct 17 '18 14:10 jbouffard

hey @jpolchlo , okay so from what i understood i need to make a new file "requirements.txt" and add the relevant dependencies line by line. that's all right? but i don't see any file called "html" in the doc directory on which "make" is running, is it because i am just viewing the code on github and not cloned on my pc ?

bhavybarca avatar Oct 18 '18 04:10 bhavybarca

Hello, @bhavybarca! Yes, that's correct. That'll be added to the docs directory. html is not a file, but rather a command that you pass to make. When you run make html, a directory called, _build will be created that has a folder called html in it.

jbouffard avatar Oct 19 '18 13:10 jbouffard