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

Issue 315 update readme #331

Merged
merged 36 commits into from
Jun 1, 2024
Merged

Issue 315 update readme #331

merged 36 commits into from
Jun 1, 2024

Conversation

fohrloop
Copy link
Owner

@fohrloop fohrloop commented Jun 1, 2024

Closes: #315

  • Complete README rewrite
  • Reuse README in RTD Overview page
  • Update README badges list
  • Clear table showing supported platforms and used methods
  • Update to pydata-sphinx-theme 0.15.3 and pin rest of the docs related
    packages. Few changes in CSS for nicer look.
  • Refactor the "Methods" documentation page. Instead of duplicating all
    methods which have keep.running and keep.presenting mode, list them
    just once and tell the supported modes in one bullet point.

@fohrloop fohrloop merged commit 7bec755 into main Jun 1, 2024
14 checks passed
@fohrloop fohrloop deleted the issue-315-update-readme branch June 1, 2024 09:26
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.

The README could be updated now as wakepy 0.9.0 is out. Reuse parts from the docs?
1 participant