Add git_commit_detail directive. #21
Merged
Conversation
This file contains 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
This directive inserts information about the state of the repository when sphinx is run to generate documentation. The following options are available: branch -- show the name of the branch commit -- show the commit hash sha_length -- number of (hex) characters to show for the commit uncommitted -- show a warning if there are uncommited changes untracked -- show a warning if there are untracked files Update documentation to include git_commit_detail. Add link to GitHub commit, with option to disable, and update the doc.
|
I should add that if this doesn't fit with your vision of where sphinx-git is going, I'm fine just keeping my own fork. |
|
I'd definitely love to merge this; let me review the PR. First up: Could you look at adding some tests? |
| --------------------------- | ||
|
|
||
| The ``git_commit_detail`` directive produces information about the current commit in the | ||
| repository against which the documentation is being built. The following options are availiable: |
|
Have had a quick scan through and, broadly, this looks good. Just gimme some tests. :) |
|
Yes of course. I got so excited I forgot about tests. :) |
|
OK, if the tests look good to you I can squash the commits or you can take them as is. |
|
Any chance this can get pulled in? |
OddBloke
added a commit
that referenced
this pull request
Apr 13, 2015
Add git_commit_detail directive.
|
Merged. Thanks @pomalley! |
|
My pleasure. |
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 directive inserts information about the state of the repository
when sphinx is run to generate documentation.
The following options are available:
branch -- show the name of the branch
commit -- show the commit hash
sha_length -- number of (hex) characters to show for the commit
uncommitted -- show a warning if there are uncommited changes
untracked -- show a warning if there are untracked files
Update documentation to include git_commit_detail.
Add link to GitHub commit, with option to disable, and update the doc.