Skip to content

docs: change code-block language value on install scripts#802

Merged
pstorz merged 3 commits intomasterfrom
dev/fbergkemper/master/code-block-language-install-scripts
Apr 26, 2021
Merged

docs: change code-block language value on install scripts#802
pstorz merged 3 commits intomasterfrom
dev/fbergkemper/master/code-block-language-install-scripts

Conversation

@frb121
Copy link
Contributor

@frb121 frb121 commented Apr 23, 2021

The changes of the PR basically make copy and paste easier.

It fixes e.g. a copy and paste problem on install scripts where shell-session
was used as language identifier for pygments instead of sh/shell.

The PR also introduces the sphinx_copybutton extension.
The sphinx_copybutton adds a copy button to all code-blocks,
which improves useability of the documentation.

Thank you for contributing to the Bareos Project!

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General
  • PR name is meaningful
  • Purpose of the PR is understood
  • Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
  • Commit descriptions are understandable and well formatted
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR
  • check-sources --since-merge does not report any problems
  • git status should not report modifications in the source tree after building and testing

@frb121 frb121 force-pushed the dev/fbergkemper/master/code-block-language-install-scripts branch 2 times, most recently from be5f52e to 9be35ef Compare April 23, 2021 13:21
The change makes copy and paste easier. Hashtags cannot be copied while
using shell-session as language value.
@frb121 frb121 force-pushed the dev/fbergkemper/master/code-block-language-install-scripts branch from 9be35ef to 6f481d8 Compare April 23, 2021 13:24
@frb121 frb121 self-assigned this Apr 23, 2021
pstorz added 2 commits April 25, 2021 13:10
This adds a copy button to ever code snippet in the documentation.
@frb121 frb121 marked this pull request as ready for review April 26, 2021 10:42
@frb121 frb121 requested a review from pstorz April 26, 2021 11:02
@pstorz pstorz merged commit cce3267 into master Apr 26, 2021
@pstorz pstorz deleted the dev/fbergkemper/master/code-block-language-install-scripts branch April 26, 2021 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants