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 #684

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

misl6
Copy link
Member

@misl6 misl6 commented Oct 8, 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 for latest 1.6.0 pyjnius release. (so a 1.6.1 will be released just after this PR is merged)

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 pyjnius version from pyjnius, by reading it on __init__.py file (we never updated that previously, so manual is not an option 😀, but we can't install pyjnius)
  • Now the copyright year is updated automatically (again: we never updated that previously, so manual is not an option 😀)

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

@misl6 misl6 assigned AndreMiras and unassigned AndreMiras Oct 8, 2023
@misl6 misl6 changed the title Add (now mandatory) .readthedocs.yaml file, add docs extras and update sphinx conf [WIP] Add (now mandatory) .readthedocs.yaml file, add docs extras and update sphinx conf Oct 8, 2023
@misl6
Copy link
Member Author

misl6 commented Oct 8, 2023

Update: Moved back in WIP, as while doing the same changes for pyobjus, I needed to follow another approach (as we can't install pyobjus on readthedocs), and would be nice to use the same.

@misl6 misl6 changed the title [WIP] Add (now mandatory) .readthedocs.yaml file, add docs extras and update sphinx conf Add (now mandatory) .readthedocs.yaml file, add docs extras and update sphinx conf Oct 9, 2023
@misl6 misl6 requested a review from AndreMiras October 9, 2023 17:07
@misl6
Copy link
Member Author

misl6 commented Oct 9, 2023

Update: Now readthedocs.org can process the docs build without installing pyjnius (and its dependencies)

@cmacdonald
Copy link
Contributor

lgtm

Copy link
Member

@AndreMiras AndreMiras left a comment

Choose a reason for hiding this comment

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

Thanks for investigating into this

@misl6 misl6 merged commit c144e96 into master Oct 10, 2023
415 checks passed
@misl6 misl6 deleted the feat/add-readthedocs-file branch October 10, 2023 06:50
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.

3 participants