RST + Sphinx: How to configure search to make it work differently?
I have a documentation project using sphinx. I have two questions regarding the search behaviour:
Question 1: When I search for something in the docs, I get rst output. How can I prevent that and make it more human readable? For example look at the following screenshot.
Question 2: When I click on a search item, sphinx automatically highlights the terms. I do not want that to happen. How can I prevent it from applying highlights. For example look at the following screenshot.
python-sphinx restructuredtext read-the-docs
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
add a comment |
I have a documentation project using sphinx. I have two questions regarding the search behaviour:
Question 1: When I search for something in the docs, I get rst output. How can I prevent that and make it more human readable? For example look at the following screenshot.
Question 2: When I click on a search item, sphinx automatically highlights the terms. I do not want that to happen. How can I prevent it from applying highlights. For example look at the following screenshot.
python-sphinx restructuredtext read-the-docs
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
Regarding question 2, see stackoverflow.com/a/48771802/407651
– mzjn
yesterday
Regarding question 1: I thought that something had been done to fix this, but I'm not sure what to expect. See github.com/sphinx-doc/sphinx/issues/1618. What version of Sphinx do you use?
– mzjn
yesterday
By the way, in the future please ask one question at a time.
– mzjn
yesterday
Sorry about that and thanks for helping out. I am using sphinx version 1.8.3
– Ranjith Ramachandra
yesterday
add a comment |
I have a documentation project using sphinx. I have two questions regarding the search behaviour:
Question 1: When I search for something in the docs, I get rst output. How can I prevent that and make it more human readable? For example look at the following screenshot.
Question 2: When I click on a search item, sphinx automatically highlights the terms. I do not want that to happen. How can I prevent it from applying highlights. For example look at the following screenshot.
python-sphinx restructuredtext read-the-docs
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
I have a documentation project using sphinx. I have two questions regarding the search behaviour:
Question 1: When I search for something in the docs, I get rst output. How can I prevent that and make it more human readable? For example look at the following screenshot.
Question 2: When I click on a search item, sphinx automatically highlights the terms. I do not want that to happen. How can I prevent it from applying highlights. For example look at the following screenshot.
python-sphinx restructuredtext read-the-docs
python-sphinx restructuredtext read-the-docs
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
edited yesterday
Ranjith Ramachandra
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
asked yesterday
Ranjith RamachandraRanjith Ramachandra
4,21873471
4,21873471
Regarding question 2, see stackoverflow.com/a/48771802/407651
– mzjn
yesterday
Regarding question 1: I thought that something had been done to fix this, but I'm not sure what to expect. See github.com/sphinx-doc/sphinx/issues/1618. What version of Sphinx do you use?
– mzjn
yesterday
By the way, in the future please ask one question at a time.
– mzjn
yesterday
Sorry about that and thanks for helping out. I am using sphinx version 1.8.3
– Ranjith Ramachandra
yesterday
add a comment |
Regarding question 2, see stackoverflow.com/a/48771802/407651
– mzjn
yesterday
Regarding question 1: I thought that something had been done to fix this, but I'm not sure what to expect. See github.com/sphinx-doc/sphinx/issues/1618. What version of Sphinx do you use?
– mzjn
yesterday
By the way, in the future please ask one question at a time.
– mzjn
yesterday
Sorry about that and thanks for helping out. I am using sphinx version 1.8.3
– Ranjith Ramachandra
yesterday
Regarding question 2, see stackoverflow.com/a/48771802/407651
– mzjn
yesterday
Regarding question 2, see stackoverflow.com/a/48771802/407651
– mzjn
yesterday
Regarding question 1: I thought that something had been done to fix this, but I'm not sure what to expect. See github.com/sphinx-doc/sphinx/issues/1618. What version of Sphinx do you use?
– mzjn
yesterday
Regarding question 1: I thought that something had been done to fix this, but I'm not sure what to expect. See github.com/sphinx-doc/sphinx/issues/1618. What version of Sphinx do you use?
– mzjn
yesterday
By the way, in the future please ask one question at a time.
– mzjn
yesterday
By the way, in the future please ask one question at a time.
– mzjn
yesterday
Sorry about that and thanks for helping out. I am using sphinx version 1.8.3
– Ranjith Ramachandra
yesterday
Sorry about that and thanks for helping out. I am using sphinx version 1.8.3
– Ranjith Ramachandra
yesterday
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54251404%2frst-sphinx-how-to-configure-search-to-make-it-work-differently%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54251404%2frst-sphinx-how-to-configure-search-to-make-it-work-differently%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Regarding question 2, see stackoverflow.com/a/48771802/407651
– mzjn
yesterday
Regarding question 1: I thought that something had been done to fix this, but I'm not sure what to expect. See github.com/sphinx-doc/sphinx/issues/1618. What version of Sphinx do you use?
– mzjn
yesterday
By the way, in the future please ask one question at a time.
– mzjn
yesterday
Sorry about that and thanks for helping out. I am using sphinx version 1.8.3
– Ranjith Ramachandra
yesterday