📝 docs: restructure and fix cross-references#419
Merged
gaborbernat merged 2 commits intotox-dev:mainfrom Feb 12, 2026
Merged
Conversation
Several convenience functions in __init__.py had wrong Sphinx cross-references pointing to `roaming` instead of `multipath` or `opinion`. The _MacOSDefaults and _UnixDefaults classes referenced a non-existent `platformdirs.xdg` module instead of `platformdirs._xdg`. Also fixes grammar issues (appname, opinion, user_documents_path), clarifies multipath scope, and adds missing docstrings for _pick_get_win_folder and the Android class.
9b7570e to
6f2c308
Compare
The README was a monolithic RST file containing the full API showcase for every platform, making it hard to navigate. The Sphinx docs had a single api.rst page and a sparse index. Replaced README.rst with a lean README.md focused on quick start and links to readthedocs. Split Sphinx docs into usage guide (parameters, examples), complete API reference (added missing user_desktop and site_runtime entries), and a platform details page with comparison table. Fixed CONTRIBUTING.md to reference tox instead of hatch, and fixed proselint invocation for its new CLI.
27e35b3 to
61e2366
Compare
This was referenced Feb 13, 2026
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
1 participant
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.
The README was a monolithic RST file containing full output examples for every platform, making it unwieldy for newcomers trying to understand what the library does. The Sphinx docs had a single
api.rstpage with a sparse index, and several public API entries (user_desktop_dir/user_desktop_path,site_runtime_dir/site_runtime_path) were missing. Docstrings had broken cross-references --:param multipath:and:param opinion:both pointed toroaminginstead of their own attributes, and class references used the wrong module path forXDGMixin.📝 The README is now a lean
README.mdwith a quick-start example and links to readthedocs. The Sphinx docs are split into a usage guide (all parameters with examples), a complete API reference, and a platform details page with a cross-platform comparison table. Docstrings across the codebase are corrected so Sphinx renders proper hyperlinks.CONTRIBUTING.mdnow referencestoxinstead of the already-removedhatch, and theproselintinvocation intox.tomlis updated for its new subcommand CLI.