Skip to content

Commit

Permalink
RTD update (#346)
Browse files Browse the repository at this point in the history
* RTD update

* Prepare next driver version

* ping

* Updated yaml

* Updated version

* Removed command

* Only running the doc tests

* Keeping version at 8.1.0
  • Loading branch information
apetenchea authored Jul 23, 2024
1 parent 95b791c commit 324eb66
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -98,5 +98,6 @@ jobs:
- name: Run Sphinx doctest
run: python -m sphinx -b doctest docs docs/_build

- name: Generate Sphinx HTML
run: python -m sphinx -b html -W docs docs/_build
# No longer needed as this is handled by Read the Docs
#- name: Generate Sphinx HTML
# run: python -m sphinx -b html -W docs docs/_build
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
builder: html
# Fail on all warnings to avoid broken references
fail_on_warning: true

Expand Down
2 changes: 1 addition & 1 deletion arango/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def normalize_headers(
if driver_flags is not None:
for flag in driver_flags:
flags = flags + flag + ";"
driver_version = "7.7.0"
driver_version = "8.1.0"
driver_header = "python-arango/" + driver_version + " (" + flags + ")"
normalized_headers: Headers = {
"charset": "utf-8",
Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
html_theme = "sphinx_rtd_theme"
master_doc = "index"

# Set canonical URL from the Read the Docs Domain
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "docs.python-arango.com")

autodoc_member_order = "bysource"

doctest_global_setup = """
Expand Down

0 comments on commit 324eb66

Please sign in to comment.