OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-22 06:25:12 +01:00
Code Issues Projects Releases Packages Wiki Activity

Improve HTML Download of Documentation (#4146)

Browse source
This commit is contained in:
Bibo-Joshi 2024-03-05 17:16:14 +01:00 committed by GitHub
parent 1b98e440fa
commit 437261f716
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 41 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
.readthedocs.yml
View file

@ -12,7 +12,6 @@ sphinx:
# Optionally build your docs in additional formats such as PDF # Optionally build your docs in additional formats such as PDF
formats: formats:
- pdf - pdf
- htmlzip
# Optionally set the version of Python and requirements required to build your docs # Optionally set the version of Python and requirements required to build your docs
python: python:
@ -25,6 +24,17 @@ build:
os: ubuntu-22.04 os: ubuntu-22.04
tools: tools:
python: "3" # latest stable cpython version python: "3" # latest stable cpython version
jobs:
post_build:
# Based on https://github.com/readthedocs/readthedocs.org/issues/3242#issuecomment-1410321534
# This provides a HTML zip file for download, with the same structure as the hosted website
- mkdir --parents $READTHEDOCS_OUTPUT/htmlzip
- cp --recursive $READTHEDOCS_OUTPUT/html $READTHEDOCS_OUTPUT/$READTHEDOCS_PROJECT
# Hide the "other versions" dropdown. This is a workaround for those versions being shown,
# but not being accessible, as they are not built. Also, they hide the actual sidebar menu
# that is relevant only on ReadTheDocs.
- echo "#furo-readthedocs-versions{display:none}" >> $READTHEDOCS_OUTPUT/$READTHEDOCS_PROJECT/_static/styles/furo-extensions.css
- cd $READTHEDOCS_OUTPUT ; zip --recurse-path --symlinks htmlzip/$READTHEDOCS_PROJECT.zip $READTHEDOCS_PROJECT
search: search:
ranking: # bump up rank of commonly searched pages: (default: 0, values range from -10 to 10) ranking: # bump up rank of commonly searched pages: (default: 0, values range from -10 to 10)