Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #2155: Support code directive #6132

Merged
merged 3 commits into from
Mar 10, 2019

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Mar 3, 2019

Feature or Bugfix

  • Bugfix

Purpose

  • refs: Use reStructuredText's code directive #2155
  • It would be better to integrate code directive with code-block directive. But we need to have deeper discussion about it. So this only resolve that code directive has been not working in Sphinx. Let's discuss about integration in another topic.
  • Note: sourcecode directive still has been incompatible with docutils'. In Sphinx, it is an alias of code-block directive (since its birth, f2ff041). On the other hand, in docutils, it is an alias of code directive.

@tk0miya tk0miya added this to the 2.0.0 milestone Mar 3, 2019
@tk0miya
Copy link
Member Author

tk0miya commented Mar 3, 2019

I did not update our document. I suspect two "code block" directives will confuse users. This change is only needed for compatibility with standard reStructuredText, I believe.

@codecov
Copy link

codecov bot commented Mar 3, 2019

Codecov Report

Merging #6132 into 2.0 will increase coverage by 0.01%.
The diff coverage is 97.29%.

Impacted file tree graph

@@            Coverage Diff             @@
##              2.0    #6132      +/-   ##
==========================================
+ Coverage   82.71%   82.72%   +0.01%     
==========================================
  Files         272      274       +2     
  Lines       39214    39269      +55     
  Branches     5856     5861       +5     
==========================================
+ Hits        32434    32487      +53     
- Misses       5447     5448       +1     
- Partials     1333     1334       +1
Impacted Files Coverage Δ
tests/test_directive_other.py 100% <100%> (ø) ⬆️
sphinx/testing/restructuredtext.py 100% <100%> (ø)
tests/test_directive_patch.py 100% <100%> (ø)
sphinx/directives/patches.py 94.82% <100%> (+1.21%) ⬆️
sphinx/directives/__init__.py 89.18% <80%> (-1.2%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d7024fe...cf74a71. Read the comment docs.

@tk0miya
Copy link
Member Author

tk0miya commented Mar 10, 2019

I'm merging this now. Please let me know if you have comment.

@tk0miya tk0miya merged commit 63c05f2 into sphinx-doc:2.0 Mar 10, 2019
@tk0miya tk0miya deleted the 2155_code_directive branch March 10, 2019 03:22
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant