📝 docs(usage): document use_site_for_root parameter#437
Closed
gaborbernat wants to merge 4 commits into
Closed
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.
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.
Merges changes from upstream/main including: - use_site_for_root parameter (tox-dev#426) - site_state_dir and site_log_dir APIs (tox-dev#424, tox-dev#425) - user_bin_dir and user_applications_dir APIs (tox-dev#430, tox-dev#432) - Windows environment variable overrides (tox-dev#427, tox-dev#428) - Various bug fixes and improvements Adds missing documentation for use_site_for_root parameter in the Usage Guide, addressing issue tox-dev#433. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Issue tox-dev#433 reported that the use_site_for_root parameter was missing from the Usage Guide despite being available in the API. This parameter was added in tox-dev#426 but documentation was not included in the usage guide. Added a new section documenting use_site_for_root alongside the other parameters. This helps users discover the feature when they need to configure system services running as root to use system-wide directories instead of root's home directory. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Member
Author
|
Closing to replace with clean single commit PR |
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
use_site_for_rootparameter was added in #426 but wasn't documented in the Usage Guide. 📚 Users had no way to discover this feature when configuring system services running as root that need to use system-wide directories instead of root's home directory.Added a dedicated section in the Usage Guide documenting
use_site_for_rootalongside other parameters likeensure_exists,multipath, androaming. The documentation explains the Unix-only behavior, the default value for backwards compatibility, and includes a practical example showing how root processes redirect to site directories.This addresses issue #433 and completes the documentation for the feature introduced in #426.
🤖 Generated with Claude Code