Skip to content

Commit 324eb66

Browse files
authored
RTD update (#346)
* RTD update * Prepare next driver version * ping * Updated yaml * Updated version * Removed command * Only running the doc tests * Keeping version at 8.1.0
1 parent 95b791c commit 324eb66

File tree

4 files changed

+8
-3
lines changed

4 files changed

+8
-3
lines changed

.github/workflows/docs.yaml

+3-2
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,6 @@ jobs:
9898
- name: Run Sphinx doctest
9999
run: python -m sphinx -b doctest docs docs/_build
100100

101-
- name: Generate Sphinx HTML
102-
run: python -m sphinx -b html -W docs docs/_build
101+
# No longer needed as this is handled by Read the Docs
102+
#- name: Generate Sphinx HTML
103+
# run: python -m sphinx -b html -W docs docs/_build

.readthedocs.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ sphinx:
1515
configuration: docs/conf.py
1616
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
1717
# builder: "dirhtml"
18+
builder: html
1819
# Fail on all warnings to avoid broken references
1920
fail_on_warning: true
2021

arango/request.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ def normalize_headers(
1212
if driver_flags is not None:
1313
for flag in driver_flags:
1414
flags = flags + flag + ";"
15-
driver_version = "7.7.0"
15+
driver_version = "8.1.0"
1616
driver_header = "python-arango/" + driver_version + " (" + flags + ")"
1717
normalized_headers: Headers = {
1818
"charset": "utf-8",

docs/conf.py

+3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
html_theme = "sphinx_rtd_theme"
1818
master_doc = "index"
1919

20+
# Set canonical URL from the Read the Docs Domain
21+
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "docs.python-arango.com")
22+
2023
autodoc_member_order = "bysource"
2124

2225
doctest_global_setup = """

0 commit comments

Comments
 (0)