readthedocs / readthedocs.org

The source code that powers readthedocs.org
https://readthedocs.org/
MIT License
8.01k stars 3.58k forks source link

Search returns wrong url #3164

Closed amike80 closed 5 years ago

amike80 commented 7 years ago

Details

Search returns the wrong url. However a build on my PC does work 0K.

Expected Result

Searching for wifi should return the following url: http://redpitaya.readthedocs.io/en/latest/doc/quickStart/troubleshooting/troubleshooting.html?highlight=wifi

Actual Result

Search returns wrong url (bellow). However document is build correctly and all tocs and links in the document are working correctly. As can be seen doc/ directory is missing in the search url. http://redpitaya.readthedocs.io/en/latest/quickStart/troubleshooting/troubleshooting.html?highlight=wifi

slightlynybbled commented 6 years ago

The first URL that you are referencing actually takes me to the maze. The 'actual result' URL takes me to a URL that looks appropriate for what you are doing. In addition, when I actually search for wifi, I get the appropriate links. As you state, all all actually appears to be OK.

agjohnson commented 6 years ago

Further, I'd expect the URL path to not include /doc, so the hosted version looks exactly as I would expect.

amike80 commented 6 years ago

Hi,

sorry for the confusion the links for Expected result and Actual result are for the latest document where conf.py was moved inside the the doc folder, this seems to mitigate the issue. We could not leave the document in a state where the search does not work.

Now this is wrong as conf.py is not in the root directory as it should be.

I would've added the links to the specific build (6117144) if I found a way. I also figured that it would be enough to provide a specific build (6117144) url.

For the local builds I've installed sphinx and other required packages on my PC. I tend to build the code locally before pushing it to git.

To build the code i use the following comand: make -f MakeRTD html Where MakeRTD is just a renamed version of Make file that comes with sphinx.

Hope this clears up the matter a bit.

Can anybody proved me with a way to get the urls that show to the specific build and not to the latest build?

@slightlynybbled It looks like all is functioning as desired, simply with a missing /doc in the url. Is this accurate?: That is correct.

RichardLitt commented 5 years ago

Closing this as the user hasn't responded or given more information, feel free to reopen with more information if you are still having this problem :).