Configure RTD #161
Configure RTD #161
Conversation
jakirkham
force-pushed
the
config_rtd
branch
7 times, most recently
from
ae75dbb
to
1fd0bdd
Compare
|
Tried restructuring the docs, but that doesn't seem to have fixed it. It seems like there is still something off. FWICT it seems to be related to the import structure somehow. 😕 |
jakirkham
force-pushed
the
config_rtd
branch
5 times, most recently
from
578d464
to
32ae1c1
Compare
|
🎉 This now works! 🎉 Please take a look and share feedback. |
|
great to see this is now working! I was not previously familiar with the It's not ideal that we have to hack |
|
Thanks for the feedback, @grlee77. Yeah, Using |
|
I'll have to look over this later, I need to run now. Are there any potential issues with these changes? Or is the net effect that the RTD docs are up to date? |
|
It has PR ( #164 ) in the history. So might want to check if you are ok with that change. Otherwise, no, it just sets up RTD to build. |
Seems like this is confusing Sphinx in terms of where to look for the Python sources. So if we simply drop this manipulation, this should no longer cause a problem.
Relying on the `setup.py` file to get the version information doesn't seem like a good idea. It also requires `pyfftw` to be built in source to build the docs, which really shouldn't be a requirement. Given `pyfftw.version` will have this information and should be created in source or out-of-source builds, use that instead to extract the version information.
Provides the necessary configuration files and settings to build on ReadTheDocs. Requires a hack to the build system to handle the toolchain configuration in the ReadTheDocs environment. Otherwise everything else is pretty standard.
|
Apologies for the delay on this, I've been very busy. |
|
No worries. I think the RTD project settings might need to be refreshed though. Unfortunately there is not much I can do on from my end. |
|
What needs to be done? When you say not much can be done is that because I need to do it? |
|
Yes. It's been a little while since I did this, but I would first check to see if the RTD service is enabled on this repo. Maybe it was disabled after the initial setbacks, which makes sense. I tried to put everything else in the |
|
Ok will do, thanks. btw, I invited you to be a maintainer. It's about time I excited other people in pyFFTW and you've been keen enough so far! |
|
So I tried creating a fresh RTD project without any setting changes and that seemed to work. It built a copy of docs under |
|
Cool, thanks. I plan to extend the Dask interface to 2-D and N-D on the next release of Dask. We like using pyFFTW internally for image registration. It makes for a nice speedup beyond what NumPy' FFTPACK can do. Not to mention if it helps a convolution with a large kernel go a bit faster, that is nice too. |
|
So I've set up the webhooks. I guess we see what happens... For the time being, I'm happy with just latest working! |
|
I really appreciate all your work on this, it's very valuable. |
|
Great, thanks. No problem. FWIW it looks like it is working. FYI may need to clear your cache if the docs aren't showing up correctly. |
|
No, it looks fine :) |
Builds the docs for pyFFTW on ReadTheDocs. Requires a hack to fix use the same toolchain that ReadTheDocs uses. Also relies on PR ( #162 ) to set some reasonable search paths for use with
condapackages and PR ( #164 ) to fix some things with the Sphinx configuration.ref: http://jakirkhampyfftw.readthedocs.io/en/config_rtd/index.html
ref: https://readthedocs.org/projects/jakirkhampyfftw/builds/5245737
cc @hgomersall @grlee77