Skip to content

doc: add button to copy code blocks in Dune manual#6428

Merged
rgrinberg merged 1 commit intoocaml:mainfrom
MisterDA:sphinx_copybutton
Nov 15, 2022
Merged

doc: add button to copy code blocks in Dune manual#6428
rgrinberg merged 1 commit intoocaml:mainfrom
MisterDA:sphinx_copybutton

Conversation

@MisterDA
Copy link
Copy Markdown
Contributor

This is imo a nice usability improvement ;-)

Using sphinx-copybutton https://sphinx-copybutton.readthedocs.io/en/latest/.

Hope I've setup nix flakes correctly. Building works locally but I haven't tested nix stuff.

@Alizter Alizter self-requested a review November 10, 2022 23:32
@MisterDA MisterDA force-pushed the sphinx_copybutton branch 4 times, most recently from c503c65 to ba1ebc8 Compare November 14, 2022 09:48
Copy link
Copy Markdown
Collaborator

@Alizter Alizter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff!

Uses sphinx-copybutton <https://sphinx-copybutton.readthedocs.io/en/latest/>.

Signed-off-by: Antonin Décimo <antonin@tarides.com>
@Alizter Alizter added this to the 3.6.0 milestone Nov 14, 2022
@emillon emillon removed this from the 3.6.0 milestone Nov 14, 2022
@emillon
Copy link
Copy Markdown
Collaborator

emillon commented Nov 14, 2022

docs are deployed separately from releases so I'm removing the milestone

@Alizter
Copy link
Copy Markdown
Collaborator

Alizter commented Nov 14, 2022

@emillon Could you merge this anyway?

@rgrinberg rgrinberg merged commit d17049f into ocaml:main Nov 15, 2022
@MisterDA MisterDA deleted the sphinx_copybutton branch November 15, 2022 15:55
jchavarri added a commit to jchavarri/dune that referenced this pull request Nov 16, 2022
* main:
  test(melange): demonstrate error in melange compilation trying to build @ALL (ocaml#6485)
  chore(nix): make it faster to get melange (ocaml#6347)
  refactor: status db style tweaks (ocaml#6478)
  fix: improve error message for status db (ocaml#6479)
  refactor: remove unused [flags] parameter (ocaml#6480)
  refactor(ctypes): remove pesky aliases (ocaml#6482)
  chore: tweak `hacking.rst` following `dune.exe` move to _boot (ocaml#6484)
  feature(coq): automatic detection of native
  chore(coq): bump Coq lang to 0.7
  test: disable formatting for a single dune file (ocaml#6465)
  refactor: clean up module compilation (ocaml#6461)
  doc: add button to copy code blocks in Dune manual (ocaml#6428)
  refactor: deforest a set conversion (ocaml#6473)
  refactor: remove temporary map used for sorting (ocaml#6472)
  fix(melange): handle include_subdirs unqualified (ocaml#6475)
jchavarri added a commit to jchavarri/dune that referenced this pull request Nov 16, 2022
* main:
  test(melange): demonstrate error in melange compilation trying to build @ALL (ocaml#6485)
  chore(nix): make it faster to get melange (ocaml#6347)
  refactor: status db style tweaks (ocaml#6478)
  fix: improve error message for status db (ocaml#6479)
  refactor: remove unused [flags] parameter (ocaml#6480)
  refactor(ctypes): remove pesky aliases (ocaml#6482)
  chore: tweak `hacking.rst` following `dune.exe` move to _boot (ocaml#6484)
  feature(coq): automatic detection of native
  chore(coq): bump Coq lang to 0.7
  test: disable formatting for a single dune file (ocaml#6465)
  refactor: clean up module compilation (ocaml#6461)
  doc: add button to copy code blocks in Dune manual (ocaml#6428)
  refactor: deforest a set conversion (ocaml#6473)
  refactor: remove temporary map used for sorting (ocaml#6472)
  fix(melange): handle include_subdirs unqualified (ocaml#6475)
rikusilvola added a commit to rikusilvola/dune that referenced this pull request Sep 20, 2023
d17049f (doc: add button to copy code blocks in Dune manual (ocaml#6428), 2022-11-15)
added dependency on sphinx-copybutton - now documented
Also fixed linking to sphinx-autobuild
rikusilvola added a commit to rikusilvola/dune that referenced this pull request Sep 20, 2023
d17049f (doc: add button to copy code blocks in Dune manual (ocaml#6428), 2022-11-15)
added dependency on sphinx-copybutton - now documented
Also fixed linking to sphinx-autobuild

Signed-off-by: Riku Silvola <riku@tarides.com>
emillon pushed a commit that referenced this pull request Sep 20, 2023
d17049f (doc: add button to copy code blocks in Dune manual (#6428), 2022-11-15)
added dependency on sphinx-copybutton - now documented
Also fixed linking to sphinx-autobuild

Signed-off-by: Riku Silvola <riku@tarides.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants