-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
locally installed readthedocs #2281
Comments
Sounds like you aren't running elasticsearch. The error looks odd, I'd expect port numbers there. Can you edit with error pasted as a code block, not a quoted comment? |
Also: This bug is being marked as community effort. The core team will try to facilitate resolution with this issue, but without the resources to support external installations outside of our production environment, we must rely on the community to help. You can read more information on our philosophy around supporting Read the Docs as an open source and volunteer run effort here: |
Should I ? It is not mentioned on the page. Maybe the docs are lacking.. |
@62mkv To build the project locally, you will need to pip install the requirements.txt file -- see README This file includes elasticsearch among the dependencies. |
I think the documentation should explicitly mention Elasticsearch, Redis (and possibly PostgreSQL too). It would also be good to add a link to http://docs.readthedocs.io/en/latest/rtfd.html?highlight=elasticsearch#elastic-search-setup This could be a good task for new contributors. |
Hey, can I take up this bug? I am a newbie |
Is this still an issue? I can take it. |
Hi @JosemyD, yes, this is still needs to be addressed. You find the installation document at https://github.com/rtfd/readthedocs.org/blob/master/docs/install.rst. |
Hello! I have installed the project locally according to docs.readthedocs.io/en/latest/install.html#installing-read-the-docs.
I am a newbie here trying to understand the code so that I can contribute. Thanks for the help! |
@shubham76 you need to setup elasticsearch to get the search working (this isn't mandatory to start contributing or for your builds) You can check this PR with some improvements on the installation guide #3631 |
@stsewd Okay! I don't think I am going to use search for now. I will leave this aside then! |
Details
Expected Result
I've installed readthedocs locally accorging to this manual: http://docs.readthedocs.io/en/latest/install.html#installing-read-the-docs
This manual is completed by me on Debian VM, up to and including "building documentation for pip"
(I've managed to download it as epub and it seems correct)
BUT!
I was expecting (don't know why, but it is not mentioned explicitly that this will not be working) that the "Search" function will be .. functioning.
Actual Result
Actually, I get an error like this:
every time I try to perform a search
The text was updated successfully, but these errors were encountered: