python - RTD: Read the docs only import links and not the contents in it -
i new read docs. have documentation folder docs in github repo created using sphinx in local machine. tried link docs readthedocs.
from settings of repo added read docs service.
from read docs website imported project.
but, documentation in read docs shows front page of index.html file. when click links empty. however, in local machine links text in it.
my github repo this: github repo
my readthedocs link : readthedocs docs
file structure
- docs
- html
- rst
** conf.py - source
- makefile
- src
the main page of index.html
in machine when click first link has contents
in readthedocs website when click first link emptey
note whole repo same in both github website , local machine.
files in computer uploaded in github, still readthedocs can not find documentation.
question: how can show contents of links in readthedocs ?
what doing wrong?
there way fix problem or rtd shows front page?
simple test:
can download repo (5mb) , run index.html shows contents inside a0_interpolate_flux link, if click same link in readthedocs given above not show docstring contents.
update
have googled lot , tried read docs website, no avail. wonder how same html page opens differently in local machine , readthedocs webhost?
some related links following:
[1]: https://stackoverflow.com/questions/41029181/read-the-docs-not-updating-with-new-files?rq=1
you need tell rtd install package. see rtd faq my project isn’t building autodoc.
if @ rtd build history, , expand third bar, see import errors.
to fix it:
- configure rtd admin use virtual environment , install package, using
requirements.txt
file. - create
requirements.txt
file , push repo, specifying project's requirements, included.
Comments
Post a Comment