Skip to content

Configure Read the Docs and point the README and project URLs at the hosted documentation - #18

Merged
avgvi merged 1 commit into
masterfrom
docs/readthedocs
Oct 11, 2026
Merged

avgvi merged 1 commit into
masterfrom
docs/readthedocs

Conversation

@avgvi

@avgvi avgvi commented Oct 11, 2026

Copy link
Copy Markdown
Member

Hosts the documentation on Read the Docs instead of linking to the .rst sources on GitHub.

  • .readthedocs.yaml: Ubuntu 24.04, Python 3.12, Sphinx with fail_on_warning, dependencies from docs/requirements.txt (Django 5.2 for DjangoCache, Sphinx below 10). docs/conf.py already puts the repository root on sys.path, so the package is not installed in the build.
  • README links and the new Documentation project URL point at https://diskcache-community.readthedocs.io/en/latest/. latest rather than stable because the v5.7.0 tag predates the config file and cannot be built; stable becomes usable from the next tag.
  • docs/development.rst describes the hosting; the changelog gets an Unreleased section.

Verified locally: sphinx -T -W --keep-going -b html succeeds, all six README anchors exist on the built tutorial page, and the rstcheck, doc8 and docs tox environments pass.

@avgvi
avgvi merged commit dc53eef into master Oct 11, 2026
22 checks passed
@avgvi
avgvi deleted the docs/readthedocs branch October 11, 2026 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant