📝 docs: restructure docs and fix cross-references#417
Closed
gaborbernat wants to merge 1 commit intotox-dev:mainfrom
Closed
📝 docs: restructure docs and fix cross-references#417gaborbernat wants to merge 1 commit intotox-dev:mainfrom
gaborbernat wants to merge 1 commit intotox-dev:mainfrom
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.
gaborbernat
changed the title
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 hard to scan. The Sphinx docs consisted of a single
api.rstpage with a sparse index, and several API entries (user_desktop_dir/user_desktop_path,site_runtime_dir/site_runtime_path) were missing entirely. The docstrings also had broken cross-references (e.g.:param multipath: See roaming) and stale wording.This replaces
README.rstwith a leanREADME.mdfocused on a quick-start example and links to readthedocs. The Sphinx docs are split into three pages: a usage guide covering all parameters with examples, a complete API reference, and a platform details page with a comparison table of default paths across macOS/Windows/Linux/Android. Each platform section includes theautoclassdirective so the class docs render inline with the platform context.CONTRIBUTING.mdnow referencestoxinstead ofhatch(which was already migrated in #415), theproselintinvocation intox.tomlis updated for its newchecksubcommand CLI, andpyproject.tomlpoints to the newREADME.md.