Skip to content

Add (now mandatory) .readthedocs.yaml file, add docs requirements.txt and update sphinx conf#2916

Merged
misl6 merged 2 commits intodevelopfrom
feat/add-readthedocs-file
Nov 10, 2023
Merged

Add (now mandatory) .readthedocs.yaml file, add docs requirements.txt and update sphinx conf#2916
misl6 merged 2 commits intodevelopfrom
feat/add-readthedocs-file

Conversation

@misl6
Copy link
Copy Markdown
Member

@misl6 misl6 commented Nov 10, 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 python-for-android.

This PR does the following:

  • Adds a .readthedocs.yaml file, with the proper configuration.
  • Adds a requirements.txt file into doc 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 python-for-android version from python-for-android, by reading it on __init__.py file (we never updated that previously, so manual is not an option 😀, but we can't install python-for-android)
  • 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://python-for-android.readthedocs.io/en/feat-add-readthedocs-file

…ire is great, but unfortunately we can't use it on readthedocs builds
@misl6 misl6 merged commit 609ad2d into develop Nov 10, 2023
@AndreMiras AndreMiras deleted the feat/add-readthedocs-file branch October 21, 2024 11:09
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