Skip to content

Commit

Permalink
docs: fix deprecation of analytics in RTD
Browse files Browse the repository at this point in the history
  • Loading branch information
laurenceisla authored and steve-chavez committed Oct 29, 2024
1 parent 765696d commit 4874428
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,12 @@ def setup(app):
ogp_enable_meta_description = True
ogp_description_length = 300

# sphinxcontrib.googleanalytics configuration
if os.environ.get("READTHEDOCS"):
extensions.append("sphinxcontrib.googleanalytics")
googleanalytics_enabled = True
googleanalytics_id = "G-5CGB3QTKF1"

## RTD sets html_baseurl, ensures we use the correct env for canonical URLs
## Useful to generate correct meta tags for Open Graph
## Refs: https://github.com/readthedocs/readthedocs.org/issues/10226, https://github.com/urllib3/urllib3/pull/3064
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ sphinx-rtd-theme>=0.5.1
sphinx-rtd-dark-mode>=1.3.0
sphinx-tabs>=3.2.0
sphinx>=5.0.2
sphinxcontrib-googleanalytics>=0.4
sphinxext-opengraph==0.9.1
urllib3==2.2.3

0 comments on commit 4874428

Please sign in to comment.