ReadTheDocs configuration #18
Conversation
devmessias
commented
Jul 22, 2021
•
devmessias
commented
- Helios logo
- sphinx-gallery
- API
Before this, the examples was not appearing in the MDE, HeliosFr docs. This its caused due the export in helios/layouts/__init__.py. I solved that creating a condition inside of helios/docs/source/templates/custom_module_template.rst
There was a problem hiding this comment.
Hi @devmessias ,
A lot of temporary files, I recommend you update your gitignore before merging
Hi @skoudoro . We have a problem.Tthose files are created by the sphinx-gallery extension. However, I couldn't run the sphinx-gallery in the readthedocs. Also I think it's not possible to use the Xvfb on readthedocs |
devmessias
force-pushed
the
readthedocs
branch
2 times, most recently
from
b1f28e3
to
d514b92
Compare
Hi @skoudoro , we are trying to figure out the best way to run the sphinx-gallery and send this to readthedocs. We can't do that inside their environment (no Xvfb probably), so the current approach is pre-generating it and them uploading it. @devmessias proposed to have a different repo (gh-pages) for the generated documentation. We can get the org name helios-network (so the address will be helios-network.github.org/docs or something like that) and create a github action to fill this repo with the generated data. Another option would be this a page inside fury, but it could be harder for other people to reach it. What do you think? |
We have a issue due the lack of X-server on readthedocs. In addition, is not possible to install the Xvfb
|
hi @devmessias and @filipinascimento, you are now admin of https://github.com/fury-gl/helios-website you can use this repo for the website |
It seems that there is a issue with vtk and syphinx-gallery.
HeliosFr and any IPCLayout method dosen't work inside of
syphinx-gallery script.
devmessias
added
documentation
