FilesExpand file tree

master

/

.readthedocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

65 lines (56 loc) · 2.11 KB

master

/

.readthedocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

65 lines (56 loc) · 2.11 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

# .readthedocs.yaml

# Read the Docs configuration file

# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required

version: 2

# Build documentation in the docs/ directory with Sphinx

sphinx:

configuration: docs/source/conf.py

# Optionally build your docs in additional formats such as PDF

formats:

- pdf

# Optionally set the version of Python and requirements required to build your docs

python:

install:

- method: pip

path: .

build:

os: ubuntu-22.04

tools:

python: "3" # latest stable cpython version

jobs:

install:

- pip install -U pip

- pip install .[all] --group 'docs' --group 'tests' # install most dependency groups

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:

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'