2021-03-14 16:46:37 +01:00
|
|
|
# .readthedocs.yaml
|
|
|
|
|
# Read the Docs configuration file
|
|
|
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
2017-07-22 13:13:49 +02:00
|
|
|
|
2021-03-14 16:46:37 +01:00
|
|
|
# Required
|
|
|
|
|
version: 2
|
|
|
|
|
|
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
|
|
|
sphinx:
|
2024-03-05 17:16:14 +01:00
|
|
|
configuration: docs/source/conf.py
|
2021-03-14 16:46:37 +01:00
|
|
|
|
|
|
|
|
# Optionally build your docs in additional formats such as PDF
|
2017-07-22 13:13:49 +02:00
|
|
|
formats:
|
2024-03-05 17:16:14 +01:00
|
|
|
- pdf
|
2017-07-22 13:13:49 +02:00
|
|
|
|
2021-03-14 16:46:37 +01:00
|
|
|
# Optionally set the version of Python and requirements required to build your docs
|
2017-07-23 23:05:40 +02:00
|
|
|
python:
|
2024-03-05 17:16:14 +01:00
|
|
|
install:
|
|
|
|
|
- method: pip
|
|
|
|
|
path: .
|
|
|
|
|
- requirements: docs/requirements-docs.txt
|
2022-06-09 17:08:54 +02:00
|
|
|
|
|
|
|
|
build:
|
2024-03-05 17:16:14 +01:00
|
|
|
os: ubuntu-22.04
|
|
|
|
|
tools:
|
|
|
|
|
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
|
Documentation Improvements (#3214, #3217, #3218, #3271, #3289, #3292, #3303, #3312, #3306, #3319, #3326, #3314)
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
Co-authored-by: Simon Fong <44134941+simonfongnt@users.noreply.github.com>
Co-authored-by: Piotr Rogulski <rivinek@gmail.com>
Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: Or Bin <or@raftt.io>
Co-authored-by: Sandro <j32g7f67hb@liamekaens.com>
Co-authored-by: Hatim Zahid <63000127+HatimZ@users.noreply.github.com>
Co-authored-by: Robi <53259730+RobiMez@users.noreply.github.com>
Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com>
2022-11-15 09:06:23 +01:00
|
|
|
|
|
|
|
|
search:
|
2024-03-05 17:16:14 +01:00
|
|
|
ranking: # bump up rank of commonly searched pages: (default: 0, values range from -10 to 10)
|
|
|
|
|
telegram.bot.html: 7
|
|
|
|
|
telegram.message.html: 3
|
|
|
|
|
telegram.update.html: 3
|
|
|
|
|
telegram.user.html: 2
|
|
|
|
|
telegram.chat.html: 2
|
|
|
|
|
telegram.ext.application.html: 3
|
|
|
|
|
telegram.ext.filters.html: 3
|
|
|
|
|
telegram.ext.callbackcontext.html: 2
|
|
|
|
|
telegram.ext.inlinekeyboardbutton.html: 1
|
|
|
|
|
|
|
|
|
|
telegram.passport*.html: -7
|
|
|
|
|
|
|
|
|
|
ignore:
|
|
|
|
|
- changelog.html
|
|
|
|
|
- coc.html
|
|
|
|
|
- bot_methods.html#
|
|
|
|
|
- bot_methods.html
|
|
|
|
|
# Defaults
|
|
|
|
|
- search.html
|
|
|
|
|
- search/index.html
|
|
|
|
|
- 404.html
|
|
|
|
|
- 404/index.html'
|
