Removing text such as “(x.y.z method)” and “(class in x.y.z)” from genindex.html
I am using sphinx-quickstart followed by sphinx-apidoc -o doc_path package_path and make html to create the documentation for my project.
I was successful in doing so, but when I opened the genindex.html page from the build folder, I noticed that the output was in the following format
class_name (class in package.sub_package)
function_name (package.sub_package.sub_sub_package.class method)
Since the name of my package and sub packages are long, this way of display is affecting the readability.
Is there a way to remove the content in the parentheses and simply provide the listing?
python-sphinx
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
add a comment |
I am using sphinx-quickstart followed by sphinx-apidoc -o doc_path package_path and make html to create the documentation for my project.
I was successful in doing so, but when I opened the genindex.html page from the build folder, I noticed that the output was in the following format
class_name (class in package.sub_package)
function_name (package.sub_package.sub_sub_package.class method)
Since the name of my package and sub packages are long, this way of display is affecting the readability.
Is there a way to remove the content in the parentheses and simply provide the listing?
python-sphinx
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
Possible duplicate of Shorter name for the class link in Sphinx
– Steve Piercy
Nov 14 '18 at 14:39
This question is about the contents of the autogenerated alphabetical index. I don't think it is a duplicate of stackoverflow.com/questions/52395174/….
– mzjn
Nov 14 '18 at 15:06
add a comment |
I am using sphinx-quickstart followed by sphinx-apidoc -o doc_path package_path and make html to create the documentation for my project.
I was successful in doing so, but when I opened the genindex.html page from the build folder, I noticed that the output was in the following format
class_name (class in package.sub_package)
function_name (package.sub_package.sub_sub_package.class method)
Since the name of my package and sub packages are long, this way of display is affecting the readability.
Is there a way to remove the content in the parentheses and simply provide the listing?
python-sphinx
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
I am using sphinx-quickstart followed by sphinx-apidoc -o doc_path package_path and make html to create the documentation for my project.
I was successful in doing so, but when I opened the genindex.html page from the build folder, I noticed that the output was in the following format
class_name (class in package.sub_package)
function_name (package.sub_package.sub_sub_package.class method)
Since the name of my package and sub packages are long, this way of display is affecting the readability.
Is there a way to remove the content in the parentheses and simply provide the listing?
python-sphinx
python-sphinx
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
edited Nov 14 '18 at 7:40
mzjn
31.7k666154
31.7k666154
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
asked Nov 14 '18 at 7:14
Clock SlaveClock Slave
2,22852357
2,22852357
Possible duplicate of Shorter name for the class link in Sphinx
– Steve Piercy
Nov 14 '18 at 14:39
This question is about the contents of the autogenerated alphabetical index. I don't think it is a duplicate of stackoverflow.com/questions/52395174/….
– mzjn
Nov 14 '18 at 15:06
add a comment |
Possible duplicate of Shorter name for the class link in Sphinx
– Steve Piercy
Nov 14 '18 at 14:39
This question is about the contents of the autogenerated alphabetical index. I don't think it is a duplicate of stackoverflow.com/questions/52395174/….
– mzjn
Nov 14 '18 at 15:06
Possible duplicate of Shorter name for the class link in Sphinx
– Steve Piercy
Nov 14 '18 at 14:39
Possible duplicate of Shorter name for the class link in Sphinx
– Steve Piercy
Nov 14 '18 at 14:39
This question is about the contents of the autogenerated alphabetical index. I don't think it is a duplicate of stackoverflow.com/questions/52395174/….
– mzjn
Nov 14 '18 at 15:06
This question is about the contents of the autogenerated alphabetical index. I don't think it is a duplicate of stackoverflow.com/questions/52395174/….
– mzjn
Nov 14 '18 at 15:06
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%2f53294879%2fremoving-text-such-as-x-y-z-method-and-class-in-x-y-z-from-genindex-html%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%2f53294879%2fremoving-text-such-as-x-y-z-method-and-class-in-x-y-z-from-genindex-html%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
Possible duplicate of Shorter name for the class link in Sphinx
– Steve Piercy
Nov 14 '18 at 14:39
This question is about the contents of the autogenerated alphabetical index. I don't think it is a duplicate of stackoverflow.com/questions/52395174/….
– mzjn
Nov 14 '18 at 15:06