Repository navigation
Configure Read the Docs and point the README and project URLs at the hosted documentation - #18
Merged
Merged
Conversation
…hosted documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hosts the documentation on Read the Docs instead of linking to the
.rstsources on GitHub..readthedocs.yaml: Ubuntu 24.04, Python 3.12, Sphinx withfail_on_warning, dependencies fromdocs/requirements.txt(Django 5.2 forDjangoCache, Sphinx below 10).docs/conf.pyalready puts the repository root onsys.path, so the package is not installed in the build.Documentationproject URL point athttps://diskcache-community.readthedocs.io/en/latest/.latestrather thanstablebecause thev5.7.0tag predates the config file and cannot be built;stablebecomes usable from the next tag.docs/development.rstdescribes the hosting; the changelog gets an Unreleased section.Verified locally:
sphinx -T -W --keep-going -b htmlsucceeds, all six README anchors exist on the built tutorial page, and therstcheck,doc8anddocstox environments pass.