Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: tox-dev/platformdirs
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 4.9.1
Choose a base ref
...
head repository: tox-dev/platformdirs
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 4.9.2
Choose a head ref
  • 3 commits
  • 20 files changed
  • 2 contributors

Commits on Feb 15, 2026

  1. 📝 docs(platforms): fix RST formatting and TOC hierarchy (#447)

    The platforms documentation had RST formatting issues that affected the
    table of contents structure. 📌 A leftover "Default paths" header in the
    preamble with no corresponding section content has been removed to clean
    up the introduction.
    
    Platform-specific sections (macOS, Windows, Linux/Unix, Android) were
    using dashes (`---`) which render as level-2 headers, incorrectly
    appearing as main sections in the TOC. ✨ These are now level-3 headers
    (using `~~~`) to align them logically with "User directories" and
    "Shared directories" subsections they precede.
    
    The result is a cleaner, more intuitive table of contents that better
    reflects the actual documentation structure.
    gaborbernat authored Feb 15, 2026
    Configuration menu
    Copy the full SHA
    1d8448b View commit details
    Browse the repository at this point in the history

Commits on Feb 16, 2026

  1. 📝 docs: restructure following Diataxis framework (#448)

    The documentation previously mixed learning material, task recipes,
    background explanations, and API reference in the same files. A new user
    trying to get started would land in `usage.rst` alongside advanced
    platform conventions and real-world project examples, making it hard to
    follow a clear learning path. Similarly, someone looking for a quick
    recipe had to skim past explanatory prose to find the code they needed.
    
    This restructures the docs into the four quadrants of the [Diataxis
    framework](https://diataxis.fr/): a step-by-step `tutorial.rst` for
    newcomers, a recipe-focused `howto.rst` for practitioners, an
    `explanation.rst` gathering all platform conventions and design
    rationale, and the existing `api.rst`/`platforms.rst` as pure reference.
    The tutorial uses first-person plural and imperative steps with
    verifiable output at each stage. The how-to guides are action-first with
    minimal explanation, including new recipes for config merging via
    `iter_config_paths`, testing with mocks, and environment variable
    overrides. Platform convention prose that was duplicated between
    `platforms.rst` and `howto.rst` now lives in one place in
    `explanation.rst`.
    
    Beyond the restructure, this adds several Sphinx extensions
    (`sphinx-copybutton`, `sphinx-design`, `sphinx-sitemap`,
    `sphinxcontrib-mermaid`, `sphinxext-opengraph`) and a `docstrfmt`
    pre-commit hook for consistent RST and docstring formatting. The ruff
    config is adjusted to defer to `docstrfmt` for docstring style (`D213`
    ignored, `E501` ignored in favor of formatters). The `api.rst` now
    documents the `iter_*` methods and the `AppDirs` backwards-compatibility
    alias. The release workflow script is updated to match the new RST
    heading style used by `docstrfmt`.
    gaborbernat authored Feb 16, 2026
    Configuration menu
    Copy the full SHA
    3e45fa9 View commit details
    Browse the repository at this point in the history
  2. Release 4.9.2

    gaborbernat committed Feb 16, 2026
    Configuration menu
    Copy the full SHA
    72271a6 View commit details
    Browse the repository at this point in the history
Loading