How can I implement my own role in Sphinx?
.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}
0
I want to create my own role (inline markup) in Sphinx.
My example: "I have a text and I want to put forward :myRole:this one.
How to do this?
In my index.rst I include a file that declares a custom role:
.. include:: _static/myDirectives.rst.
In myDirective.rst I declare my role:
.. role:: testNewRole
:class: testNewRole
And in another rst file I use it:
I have a text and I want to use my :testNewRole:`own role here`.
python-sphinx restructuredtext
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
asked Nov 22 '18 at 12:59
C S.C S.
11
|
show 2 more comments
0
I want to create my own role (inline markup) in Sphinx.
My example: "I have a text and I want to put forward :myRole:this one.
How to do this?
In my index.rst I include a file that declares a custom role:
.. include:: _static/myDirectives.rst.
In myDirective.rst I declare my role:
.. role:: testNewRole
:class: testNewRole
And in another rst file I use it:
I have a text and I want to use my :testNewRole:`own role here`.
python-sphinx restructuredtext
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
asked Nov 22 '18 at 12:59
C S.C S.
11
1
please first try and than post your efforts here. without it you'll never get help
– DaFois
Nov 22 '18 at 13:03
1
Possible duplicate of How do I create a global role/roles in Sphinx?
– mzjn
Nov 22 '18 at 16:04
I have already tested this possibiliy.
– C S.
Nov 23 '18 at 8:16
And what happened when you tested it?
– mzjn
Nov 23 '18 at 12:08
1
My first solution is ok if the name is lower-case. Thank you.
– C S.
Nov 23 '18 at 15:34
|
show 2 more comments
0
0
0
0
I want to create my own role (inline markup) in Sphinx.
My example: "I have a text and I want to put forward :myRole:this one.
How to do this?
In my index.rst I include a file that declares a custom role:
.. include:: _static/myDirectives.rst.
In myDirective.rst I declare my role:
.. role:: testNewRole
:class: testNewRole
And in another rst file I use it:
I have a text and I want to use my :testNewRole:`own role here`.
python-sphinx restructuredtext
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
asked Nov 22 '18 at 12:59
C S.C S.
11
I want to create my own role (inline markup) in Sphinx.
My example: "I have a text and I want to put forward :myRole:this one.
How to do this?
In my index.rst I include a file that declares a custom role:
.. include:: _static/myDirectives.rst.
In myDirective.rst I declare my role:
.. role:: testNewRole
:class: testNewRole
And in another rst file I use it:
I have a text and I want to use my :testNewRole:`own role here`.
python-sphinx restructuredtext
python-sphinx restructuredtext
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
asked Nov 22 '18 at 12:59
C S.C S.
11
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
asked Nov 22 '18 at 12:59
C S.C S.
11
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
edited Nov 23 '18 at 9:10
mzjn
32.6k670160
32.6k670160
asked Nov 22 '18 at 12:59
C S.C S.
11
asked Nov 22 '18 at 12:59
C S.C S.
11
asked Nov 22 '18 at 12:59
C S.C S.
11
11
1
please first try and than post your efforts here. without it you'll never get help
– DaFois
Nov 22 '18 at 13:03
1
Possible duplicate of How do I create a global role/roles in Sphinx?
– mzjn
Nov 22 '18 at 16:04
I have already tested this possibiliy.
– C S.
Nov 23 '18 at 8:16
And what happened when you tested it?
– mzjn
Nov 23 '18 at 12:08
1
My first solution is ok if the name is lower-case. Thank you.
– C S.
Nov 23 '18 at 15:34
|
show 2 more comments
1
please first try and than post your efforts here. without it you'll never get help
– DaFois
Nov 22 '18 at 13:03
1
Possible duplicate of How do I create a global role/roles in Sphinx?
– mzjn
Nov 22 '18 at 16:04
I have already tested this possibiliy.
– C S.
Nov 23 '18 at 8:16
And what happened when you tested it?
– mzjn
Nov 23 '18 at 12:08
1
My first solution is ok if the name is lower-case. Thank you.
– C S.
Nov 23 '18 at 15:34
1
1
please first try and than post your efforts here. without it you'll never get help
– DaFois
Nov 22 '18 at 13:03
please first try and than post your efforts here. without it you'll never get help
– DaFois
Nov 22 '18 at 13:03
1
1
Possible duplicate of How do I create a global role/roles in Sphinx?
– mzjn
Nov 22 '18 at 16:04
Possible duplicate of How do I create a global role/roles in Sphinx?
– mzjn
Nov 22 '18 at 16:04
I have already tested this possibiliy.
– C S.
Nov 23 '18 at 8:16
I have already tested this possibiliy.
– C S.
Nov 23 '18 at 8:16
And what happened when you tested it?
– mzjn
Nov 23 '18 at 12:08
And what happened when you tested it?
– mzjn
Nov 23 '18 at 12:08
1
1
My first solution is ok if the name is lower-case. Thank you.
– C S.
Nov 23 '18 at 15:34
My first solution is ok if the name is lower-case. Thank you.
– C S.
Nov 23 '18 at 15:34
|
show 2 more comments
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
});
}
});
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%2f53431605%2fhow-can-i-implement-my-own-role-in-sphinx%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
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.
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%2f53431605%2fhow-can-i-implement-my-own-role-in-sphinx%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
1
please first try and than post your efforts here. without it you'll never get help
– DaFois
Nov 22 '18 at 13:03
1
Possible duplicate of How do I create a global role/roles in Sphinx?
– mzjn
Nov 22 '18 at 16:04
I have already tested this possibiliy.
– C S.
Nov 23 '18 at 8:16
And what happened when you tested it?
– mzjn
Nov 23 '18 at 12:08
1
My first solution is ok if the name is lower-case. Thank you.
– C S.
Nov 23 '18 at 15:34