Sphinx docs without JavaScript
up vote
2
down vote
favorite
I'd like to build docs using Sphinx, but without any JavaScript. Is there a straight forward way to configure Sphinx not to include any JavaScript? Setting an empty html_js_files in the conf.py doesn't do the trick.
Obviously there will be some functionality missing, like the search box. However it seems that no core functionality that I care about is impacted when manually removing the scripts.
python-sphinx
asked Nov 9 at 14:24
John
242212
add a comment |
up vote
2
down vote
favorite
I'd like to build docs using Sphinx, but without any JavaScript. Is there a straight forward way to configure Sphinx not to include any JavaScript? Setting an empty html_js_files in the conf.py doesn't do the trick.
Obviously there will be some functionality missing, like the search box. However it seems that no core functionality that I care about is impacted when manually removing the scripts.
python-sphinx
asked Nov 9 at 14:24
John
242212
add a comment |
up vote
2
down vote
favorite
up vote
2
down vote
favorite
I'd like to build docs using Sphinx, but without any JavaScript. Is there a straight forward way to configure Sphinx not to include any JavaScript? Setting an empty html_js_files in the conf.py doesn't do the trick.
Obviously there will be some functionality missing, like the search box. However it seems that no core functionality that I care about is impacted when manually removing the scripts.
python-sphinx
asked Nov 9 at 14:24
John
242212
I'd like to build docs using Sphinx, but without any JavaScript. Is there a straight forward way to configure Sphinx not to include any JavaScript? Setting an empty html_js_files in the conf.py doesn't do the trick.
Obviously there will be some functionality missing, like the search box. However it seems that no core functionality that I care about is impacted when manually removing the scripts.
python-sphinx
python-sphinx
asked Nov 9 at 14:24
John
242212
asked Nov 9 at 14:24
John
242212
asked Nov 9 at 14:24
John
242212
asked Nov 9 at 14:24
John
242212
asked Nov 9 at 14:24
John
242212
242212
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
up vote
2
down vote
accepted
Modify your theme's template where the JavaScript is included, removing that HTML tag.
answered Nov 10 at 7:02
Steve Piercy
6,17711536
Theme modification is easy, I'm talking about the scripts Sphinx includes (doctools, jquery, searchtools, underscore, ...)
– John
Nov 11 at 15:19
You should not have HTML that references a missing file, so theme modification is required. It's OK to have files on the file system that are not referenced in the HTML. You can (probably?) remove the offending JavaScript files from your theme's source directory, and they won't be copied to the build directory, if they really bother you.
– Steve Piercy
Nov 11 at 18:20
Again, I'm not talking about additional js files that come with a theme. I'm talking about the js that sphinx comes with by default and is included in every page, regardless of whatever theme you use.
– John
Nov 12 at 11:04
It might be that there is way intended to remove these (because usually you wouldn't want to do that), however there might be some configuration that I missed or some trick that is buried somewhere in the documentation that I didn't find.
– John
Nov 12 at 11:07
1
Can you please edit the question and explain what you mean by "js that sphinx comes with by default and is included in every page"? Is it the<script>tags? Something like this? stackoverflow.com/a/32786687/407651
– mzjn
Nov 12 at 14:59
|
show 2 more comments
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',
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
);
);
draft saved
draft discarded
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%2f53227558%2fsphinx-docs-without-javascript%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
up vote
2
down vote
accepted
Modify your theme's template where the JavaScript is included, removing that HTML tag.
answered Nov 10 at 7:02
Steve Piercy
6,17711536
Theme modification is easy, I'm talking about the scripts Sphinx includes (doctools, jquery, searchtools, underscore, ...)
– John
Nov 11 at 15:19
You should not have HTML that references a missing file, so theme modification is required. It's OK to have files on the file system that are not referenced in the HTML. You can (probably?) remove the offending JavaScript files from your theme's source directory, and they won't be copied to the build directory, if they really bother you.
– Steve Piercy
Nov 11 at 18:20
Again, I'm not talking about additional js files that come with a theme. I'm talking about the js that sphinx comes with by default and is included in every page, regardless of whatever theme you use.
– John
Nov 12 at 11:04
It might be that there is way intended to remove these (because usually you wouldn't want to do that), however there might be some configuration that I missed or some trick that is buried somewhere in the documentation that I didn't find.
– John
Nov 12 at 11:07
1
Can you please edit the question and explain what you mean by "js that sphinx comes with by default and is included in every page"? Is it the<script>tags? Something like this? stackoverflow.com/a/32786687/407651
– mzjn
Nov 12 at 14:59
|
show 2 more comments
up vote
2
down vote
accepted
Modify your theme's template where the JavaScript is included, removing that HTML tag.
answered Nov 10 at 7:02
Steve Piercy
6,17711536
Theme modification is easy, I'm talking about the scripts Sphinx includes (doctools, jquery, searchtools, underscore, ...)
– John
Nov 11 at 15:19
You should not have HTML that references a missing file, so theme modification is required. It's OK to have files on the file system that are not referenced in the HTML. You can (probably?) remove the offending JavaScript files from your theme's source directory, and they won't be copied to the build directory, if they really bother you.
– Steve Piercy
Nov 11 at 18:20
Again, I'm not talking about additional js files that come with a theme. I'm talking about the js that sphinx comes with by default and is included in every page, regardless of whatever theme you use.
– John
Nov 12 at 11:04
It might be that there is way intended to remove these (because usually you wouldn't want to do that), however there might be some configuration that I missed or some trick that is buried somewhere in the documentation that I didn't find.
– John
Nov 12 at 11:07
1
Can you please edit the question and explain what you mean by "js that sphinx comes with by default and is included in every page"? Is it the<script>tags? Something like this? stackoverflow.com/a/32786687/407651
– mzjn
Nov 12 at 14:59
|
show 2 more comments
up vote
2
down vote
accepted
up vote
2
down vote
accepted
Modify your theme's template where the JavaScript is included, removing that HTML tag.
answered Nov 10 at 7:02
Steve Piercy
6,17711536
Modify your theme's template where the JavaScript is included, removing that HTML tag.
answered Nov 10 at 7:02
Steve Piercy
6,17711536
answered Nov 10 at 7:02
Steve Piercy
6,17711536
answered Nov 10 at 7:02
Steve Piercy
6,17711536
answered Nov 10 at 7:02
Steve Piercy
6,17711536
6,17711536
Theme modification is easy, I'm talking about the scripts Sphinx includes (doctools, jquery, searchtools, underscore, ...)
– John
Nov 11 at 15:19
You should not have HTML that references a missing file, so theme modification is required. It's OK to have files on the file system that are not referenced in the HTML. You can (probably?) remove the offending JavaScript files from your theme's source directory, and they won't be copied to the build directory, if they really bother you.
– Steve Piercy
Nov 11 at 18:20
Again, I'm not talking about additional js files that come with a theme. I'm talking about the js that sphinx comes with by default and is included in every page, regardless of whatever theme you use.
– John
Nov 12 at 11:04
It might be that there is way intended to remove these (because usually you wouldn't want to do that), however there might be some configuration that I missed or some trick that is buried somewhere in the documentation that I didn't find.
– John
Nov 12 at 11:07
1
Can you please edit the question and explain what you mean by "js that sphinx comes with by default and is included in every page"? Is it the<script>tags? Something like this? stackoverflow.com/a/32786687/407651
– mzjn
Nov 12 at 14:59
|
show 2 more comments
Theme modification is easy, I'm talking about the scripts Sphinx includes (doctools, jquery, searchtools, underscore, ...)
– John
Nov 11 at 15:19
You should not have HTML that references a missing file, so theme modification is required. It's OK to have files on the file system that are not referenced in the HTML. You can (probably?) remove the offending JavaScript files from your theme's source directory, and they won't be copied to the build directory, if they really bother you.
– Steve Piercy
Nov 11 at 18:20
Again, I'm not talking about additional js files that come with a theme. I'm talking about the js that sphinx comes with by default and is included in every page, regardless of whatever theme you use.
– John
Nov 12 at 11:04
It might be that there is way intended to remove these (because usually you wouldn't want to do that), however there might be some configuration that I missed or some trick that is buried somewhere in the documentation that I didn't find.
– John
Nov 12 at 11:07
1
Can you please edit the question and explain what you mean by "js that sphinx comes with by default and is included in every page"? Is it the<script>tags? Something like this? stackoverflow.com/a/32786687/407651
– mzjn
Nov 12 at 14:59
Theme modification is easy, I'm talking about the scripts Sphinx includes (doctools, jquery, searchtools, underscore, ...)
– John
Nov 11 at 15:19
Theme modification is easy, I'm talking about the scripts Sphinx includes (doctools, jquery, searchtools, underscore, ...)
– John
Nov 11 at 15:19
You should not have HTML that references a missing file, so theme modification is required. It's OK to have files on the file system that are not referenced in the HTML. You can (probably?) remove the offending JavaScript files from your theme's source directory, and they won't be copied to the build directory, if they really bother you.
– Steve Piercy
Nov 11 at 18:20
You should not have HTML that references a missing file, so theme modification is required. It's OK to have files on the file system that are not referenced in the HTML. You can (probably?) remove the offending JavaScript files from your theme's source directory, and they won't be copied to the build directory, if they really bother you.
– Steve Piercy
Nov 11 at 18:20
Again, I'm not talking about additional js files that come with a theme. I'm talking about the js that sphinx comes with by default and is included in every page, regardless of whatever theme you use.
– John
Nov 12 at 11:04
Again, I'm not talking about additional js files that come with a theme. I'm talking about the js that sphinx comes with by default and is included in every page, regardless of whatever theme you use.
– John
Nov 12 at 11:04
It might be that there is way intended to remove these (because usually you wouldn't want to do that), however there might be some configuration that I missed or some trick that is buried somewhere in the documentation that I didn't find.
– John
Nov 12 at 11:07
It might be that there is way intended to remove these (because usually you wouldn't want to do that), however there might be some configuration that I missed or some trick that is buried somewhere in the documentation that I didn't find.
– John
Nov 12 at 11:07
1
1
Can you please edit the question and explain what you mean by "js that sphinx comes with by default and is included in every page"? Is it the
<script> tags? Something like this? stackoverflow.com/a/32786687/407651– mzjn
Nov 12 at 14:59
Can you please edit the question and explain what you mean by "js that sphinx comes with by default and is included in every page"? Is it the
<script> tags? Something like this? stackoverflow.com/a/32786687/407651– mzjn
Nov 12 at 14:59
|
show 2 more comments
draft saved
draft discarded
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.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- 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.
draft saved
draft discarded
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%2f53227558%2fsphinx-docs-without-javascript%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
