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

Add "copy" button to the sphinx documentation page. #609

Merged
merged 11 commits into from
May 28, 2024

Conversation

chongchonghe
Copy link
Contributor

@chongchonghe chongchonghe commented Apr 15, 2024

Description

Following https://sphinx-copybutton.readthedocs.io/en/latest/ to add a little “copy” button to the right of the code blocks. Added sphinx_copybutton extension in conf.py.

Tested in local build (make html) and it works fine, but I'm not sure if the sphinx_copybutton extension is available on the server where the website HTML is built.

Checklist

Before this pull request can be reviewed, all of these tasks should be completed. Denote completed tasks with an x inside the square brackets [ ] in the Markdown source below:

  • I have added a description (see above).
  • I have added a link to any related issues see (see above).
  • I have read the Contributing Guide.
  • I have added tests for any new physics that this PR adds to the code.
  • I have tested this PR on my local computer and all tests pass.
  • I have manually triggered the GPU tests with the magic comment /azp run.
  • I have requested a reviewer for this PR.

@chongchonghe chongchonghe requested a review from BenWibking April 15, 2024 01:24
@BenWibking
Copy link
Collaborator

You can install additional any pip packages that you need to build the docs by editing this file:
https://github.com/quokka-astro/quokka/blob/development/.github/workflows/docs.yml

@chongchonghe
Copy link
Contributor Author

You can install additional any pip packages that you need to build the docs by editing this file: https://github.com/quokka-astro/quokka/blob/development/.github/workflows/docs.yml

OK, that helps. Now every check should pass and it's ready for your review. @BenWibking

@chongchonghe chongchonghe enabled auto-merge April 17, 2024 07:36
@BenWibking
Copy link
Collaborator

BenWibking commented Apr 17, 2024

I don't think the docs render correctly. You can take a look at the output here (click to download the "github-pages" artifact): https://github.com/quokka-astro/quokka/actions/runs/8717957314?pr=609

@chongchonghe chongchonghe added this pull request to the merge queue May 28, 2024
Merged via the queue into development with commit ba38740 May 28, 2024
19 checks passed
@BenWibking BenWibking deleted the chongchong/sphinx-copy-button branch July 31, 2024 15:45
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.

2 participants