Re: [sphinx-users] Which files are involved in search results?
In case anyone finds this before learning the solution, sphinxprettysearchresults has released a new version (v0.2.0), which works with Sphinx 1.5. On Thursday, May 11, 2017 at 2:20:12 AM UTC-4, Komiya Takeshi wrote: > > Hi, > > The behavior was also discussed at #3691. It is a breaking change of > Sphinx-1.5. > https://github.com/sphinx-doc/sphinx/issues/3691 > > So far, I would not change the behavior. It is required to support > multiple mark-ups (like reST, markdown and others). > So it is better if sphinxprettysearchresults will support the new > structure. > > Thanks, > Takeshi KOMIYA > > 2017-05-04 4:59 GMT+09:00 'Erin Kelly' via sphinx-users >: > > Komiyaさんどうもありがとう。It's useful to know what's needed - and I forgot about > > updating the source files! > > > > After I posted yesterday I experimented to try to figure this out > myself, > > but my results were confused because of a compatibility problem with > Sphinx > > 1.5 and the sphinxprettysearchresults extension: > > https://github.com/sphinx-doc/sphinx/issues/3696 > > > > In case anyone else sees the problem and looks for a solution here, > here's a > > synopsis: > > - Instead of showing the text for search results, I saw HTML markup of > a > > 404 error page. > > - The search page is looking for a source file called filename.rst.txt > > instead of filename.txt. > > > > I fixed it temporarily by renaming my _sources/ files to .rst.txt but > > there's a better workaround in that github link. > > > > > > On Wednesday, May 3, 2017 at 4:24:45 AM UTC-4, Komiya Takeshi wrote: > >> > >> Hi, > >> > >> Please copy searchindex.js and files under the html/_sources/. > >> Our search script uses searchindex.js for searching at first, and also > >> uses sources files to display the search result. > >> > >> Thanks, > >> Takeshi KOMIYA > >> > >> > >> > >> 2017-05-02 6:00 GMT+09:00 'Erin Kelly' via sphinx-users > >> : > >> > I'm trying to figure out whether I can update my published HTML > >> > documentation a few files at a time - one of the problems I have with > >> > this > >> > approach is that any new files or search terms won't be found by the > old > >> > search. > >> > > >> > Is it possible to swap in the new searchindex.js file to fix this > >> > problem? > >> > Or some combination of html/searchindex.js, html/search.html, and > maybe > >> > html/_static/searchtools.js ? > >> > > >> > What are all these search-related files and what do they do? > >> > > >> > For example, say I have published an HTML doc set with 100 html > >> > articles. I > >> > add a new rst file and build it into a new doc set with > >> > new_feature.html. I > >> > don't really want to replace all 100 pages when only a few of them > have > >> > changes, so I just add the new_feature.html and maybe swap out the > index > >> > page for a new one that includes a link to it. Is there a way to also > >> > swap > >> > in new search metadata from the new build so that items in > >> > new_feature.html > >> > are found on search? > >> > > >> > > >> > > >> > > >> > -- > >> > You received this message because you are subscribed to the Google > >> > Groups > >> > "sphinx-users" group. > >> > To unsubscribe from this group and stop receiving emails from it, > send > >> > an > >> > email to sphinx-users...@googlegroups.com. > >> > To post to this group, send email to sphinx...@googlegroups.com. > >> > Visit this group at https://groups.google.com/group/sphinx-users. > >> > For more options, visit https://groups.google.com/d/optout. > > > > -- > > You received this message because you are subscribed to the Google > Groups > > "sphinx-users" group. > > To unsubscribe from this group and stop receiving emails from it, send > an > > email to sphinx-users...@googlegroups.com . > > To post to this group, send email to sphinx...@googlegroups.com > . > > Visit this group at https://groups.google.com/group/sphinx-users. > > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To post to this group, send email to sphinx-users@googlegroups.com. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
Re: [sphinx-users] Which files are involved in search results?
Hi, The behavior was also discussed at #3691. It is a breaking change of Sphinx-1.5. https://github.com/sphinx-doc/sphinx/issues/3691 So far, I would not change the behavior. It is required to support multiple mark-ups (like reST, markdown and others). So it is better if sphinxprettysearchresults will support the new structure. Thanks, Takeshi KOMIYA 2017-05-04 4:59 GMT+09:00 'Erin Kelly' via sphinx-users: > Komiyaさんどうもありがとう。It's useful to know what's needed - and I forgot about > updating the source files! > > After I posted yesterday I experimented to try to figure this out myself, > but my results were confused because of a compatibility problem with Sphinx > 1.5 and the sphinxprettysearchresults extension: > https://github.com/sphinx-doc/sphinx/issues/3696 > > In case anyone else sees the problem and looks for a solution here, here's a > synopsis: > - Instead of showing the text for search results, I saw HTML markup of a > 404 error page. > - The search page is looking for a source file called filename.rst.txt > instead of filename.txt. > > I fixed it temporarily by renaming my _sources/ files to .rst.txt but > there's a better workaround in that github link. > > > On Wednesday, May 3, 2017 at 4:24:45 AM UTC-4, Komiya Takeshi wrote: >> >> Hi, >> >> Please copy searchindex.js and files under the html/_sources/. >> Our search script uses searchindex.js for searching at first, and also >> uses sources files to display the search result. >> >> Thanks, >> Takeshi KOMIYA >> >> >> >> 2017-05-02 6:00 GMT+09:00 'Erin Kelly' via sphinx-users >> : >> > I'm trying to figure out whether I can update my published HTML >> > documentation a few files at a time - one of the problems I have with >> > this >> > approach is that any new files or search terms won't be found by the old >> > search. >> > >> > Is it possible to swap in the new searchindex.js file to fix this >> > problem? >> > Or some combination of html/searchindex.js, html/search.html, and maybe >> > html/_static/searchtools.js ? >> > >> > What are all these search-related files and what do they do? >> > >> > For example, say I have published an HTML doc set with 100 html >> > articles. I >> > add a new rst file and build it into a new doc set with >> > new_feature.html. I >> > don't really want to replace all 100 pages when only a few of them have >> > changes, so I just add the new_feature.html and maybe swap out the index >> > page for a new one that includes a link to it. Is there a way to also >> > swap >> > in new search metadata from the new build so that items in >> > new_feature.html >> > are found on search? >> > >> > >> > >> > >> > -- >> > You received this message because you are subscribed to the Google >> > Groups >> > "sphinx-users" group. >> > To unsubscribe from this group and stop receiving emails from it, send >> > an >> > email to sphinx-users...@googlegroups.com. >> > To post to this group, send email to sphinx...@googlegroups.com. >> > Visit this group at https://groups.google.com/group/sphinx-users. >> > For more options, visit https://groups.google.com/d/optout. > > -- > You received this message because you are subscribed to the Google Groups > "sphinx-users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to sphinx-users+unsubscr...@googlegroups.com. > To post to this group, send email to sphinx-users@googlegroups.com. > Visit this group at https://groups.google.com/group/sphinx-users. > For more options, visit https://groups.google.com/d/optout. -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To post to this group, send email to sphinx-users@googlegroups.com. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
Re: [sphinx-users] Which files are involved in search results?
Komiyaさんどうもありがとう。It's useful to know what's needed - and I forgot about updating the source files! After I posted yesterday I experimented to try to figure this out myself, but my results were confused because of a compatibility problem with Sphinx 1.5 and the sphinxprettysearchresults extension: https://github.com/sphinx-doc/sphinx/issues/3696 In case anyone else sees the problem and looks for a solution here, here's a synopsis: - Instead of showing the text for search results, I saw HTML markup of a 404 error page. - The search page is looking for a source file called filename.rst.txt instead of filename.txt. I fixed it temporarily by renaming my _sources/ files to .rst.txt but there's a better workaround in that github link. On Wednesday, May 3, 2017 at 4:24:45 AM UTC-4, Komiya Takeshi wrote: > > Hi, > > Please copy searchindex.js and files under the html/_sources/. > Our search script uses searchindex.js for searching at first, and also > uses sources files to display the search result. > > Thanks, > Takeshi KOMIYA > > > > 2017-05-02 6:00 GMT+09:00 'Erin Kelly' via sphinx-users >: > > I'm trying to figure out whether I can update my published HTML > > documentation a few files at a time - one of the problems I have with > this > > approach is that any new files or search terms won't be found by the old > > search. > > > > Is it possible to swap in the new searchindex.js file to fix this > problem? > > Or some combination of html/searchindex.js, html/search.html, and maybe > > html/_static/searchtools.js ? > > > > What are all these search-related files and what do they do? > > > > For example, say I have published an HTML doc set with 100 html > articles. I > > add a new rst file and build it into a new doc set with > new_feature.html. I > > don't really want to replace all 100 pages when only a few of them have > > changes, so I just add the new_feature.html and maybe swap out the index > > page for a new one that includes a link to it. Is there a way to also > swap > > in new search metadata from the new build so that items in > new_feature.html > > are found on search? > > > > > > > > > > -- > > You received this message because you are subscribed to the Google > Groups > > "sphinx-users" group. > > To unsubscribe from this group and stop receiving emails from it, send > an > > email to sphinx-users...@googlegroups.com . > > To post to this group, send email to sphinx...@googlegroups.com > . > > Visit this group at https://groups.google.com/group/sphinx-users. > > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To post to this group, send email to sphinx-users@googlegroups.com. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
Re: [sphinx-users] Which files are involved in search results?
Hi, Please copy searchindex.js and files under the html/_sources/. Our search script uses searchindex.js for searching at first, and also uses sources files to display the search result. Thanks, Takeshi KOMIYA 2017-05-02 6:00 GMT+09:00 'Erin Kelly' via sphinx-users: > I'm trying to figure out whether I can update my published HTML > documentation a few files at a time - one of the problems I have with this > approach is that any new files or search terms won't be found by the old > search. > > Is it possible to swap in the new searchindex.js file to fix this problem? > Or some combination of html/searchindex.js, html/search.html, and maybe > html/_static/searchtools.js ? > > What are all these search-related files and what do they do? > > For example, say I have published an HTML doc set with 100 html articles. I > add a new rst file and build it into a new doc set with new_feature.html. I > don't really want to replace all 100 pages when only a few of them have > changes, so I just add the new_feature.html and maybe swap out the index > page for a new one that includes a link to it. Is there a way to also swap > in new search metadata from the new build so that items in new_feature.html > are found on search? > > > > > -- > You received this message because you are subscribed to the Google Groups > "sphinx-users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to sphinx-users+unsubscr...@googlegroups.com. > To post to this group, send email to sphinx-users@googlegroups.com. > Visit this group at https://groups.google.com/group/sphinx-users. > For more options, visit https://groups.google.com/d/optout. -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To post to this group, send email to sphinx-users@googlegroups.com. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.