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

Documentation updates #1786

Merged
merged 8 commits into from
May 20, 2024
Merged

Documentation updates #1786

merged 8 commits into from
May 20, 2024

Conversation

joaander
Copy link
Member

@joaander joaander commented May 17, 2024

Description

Make general improvements to the documentation infrastructure:

  • Use the latest version of furo
  • Update the furo page template if needed.
  • Allow keyboard navigation
  • Replace deprecated use of readthedocs google analytics
  • Add a copy button to code blocks
  • Remove references to singularity

Motivation and context

Ensure that the documentation is up to date as external actors deprecate features.

How has this been tested?

Will check the docs built on readthedocs for this pull request.

Change log

  • TODO: write change log
Changed

* Miscellaneous documentation improvements
  (`#1786 <https://github.com/glotzerlab/hoomd-blue/pull/1786>`__).

Checklist:

@joaander joaander added the validate Execute long running validation tests on pull requests label May 17, 2024
@joaander joaander marked this pull request as ready for review May 17, 2024 15:12
@joaander joaander requested review from a team, tcmoore3, tommy-waltmann and seoulfood and removed request for a team May 17, 2024 15:12
Copy link
Contributor

@tommy-waltmann tommy-waltmann left a comment

Choose a reason for hiding this comment

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

I think people are really going to like the copy button!

@joaander joaander merged commit 83b702e into trunk-patch May 20, 2024
65 of 73 checks passed
@joaander joaander deleted the update-docs branch May 20, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validate Execute long running validation tests on pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants