Add detailed-message-style option #52
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a new option 'detailed-message-style'.
detailed-message-style lets you select the style of detailed message.
You can select pre (preformatted text) or rst (text parsed as RST).
Examples::
.. git_changelog::
:detailed-message-style: pre
.. git_changelog::
:detailed-message-style: rst
Adds a new detailed-message-style 'md'.
When you select this style, detailed commit message is parsed as Markdown.
Example:
.. git_changelog::
:detailed-message-style: md
OddBloke
requested changes
Aug 19, 2019
There was a problem hiding this comment.
Hey @amedama41, this looks really good, thanks!
I have one inline request, and it'd be good if you could add something to CHANGELOG too.
docs/using.rst
Outdated
| .. note:: | ||
|
|
||
| The feature to output the messages as Markdown requires recommonmark package. | ||
| recommonmark is enable to be installed by pip. |
There was a problem hiding this comment.
Could we add an extra feature to setup.py so pip install sphinx-git[markdown] (or something similar) works?
There was a problem hiding this comment.
Thank you for reviewing.
I have added a markdown extra feature.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enables user to select detailed commit message style.
The list bellow is the selectable styles.