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 (now mandatory) .readthedocs.yaml file, add docs extras and update sphinx conf #787

Merged
merged 1 commit into from
Dec 8, 2023

Conversation

misl6
Copy link
Member

@misl6 misl6 commented Dec 7, 2023

readthedocs.org now requires a v2 configuration file, in order to build the docs.

Unfortunately, for this reason, readthedocs was unable to build docs recently.

This PR does the following:

  • Adds a .readthedocs.yaml file, with the proper configuration.
  • Adds a requirements.txt file into docs folder, so readthedocs.org can use that to install deps.
  • Updates the theme to furo, a nice and clean theme, also used by pip.
  • Takes the plyer version from plyer, by reading it on __init__.py file, as we can't import plyer on readthedocs
  • Now the copyright year is updated automatically

For PR reviewer, the newly rendered docs are available here: https://plyer.readthedocs.io/en/feat-add-readthedocs-file/

@misl6 misl6 merged commit d16addd into master Dec 8, 2023
7 of 9 checks passed
Xnot pushed a commit to Xnot/plyer that referenced this pull request Dec 29, 2023
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.

1 participant