Skip to content

Commit 1d8448b

Browse files
authored
📝 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.
1 parent f656849 commit 1d8448b

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

docs/platforms.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ Platform details
55
This page describes the default paths for each platform and any platform-specific behavior.
66

77
All examples below assume ``appname="SuperApp"`` and ``appauthor="Acme"`` unless stated otherwise.
8-
Default paths
9-
-------------
108

119
User directories
1210
~~~~~~~~~~~~~~~~
@@ -419,7 +417,7 @@ See also: :ref:`api:Shared binary directory`
419417
`Chocolatey <https://docs.chocolatey.org/en-us/choco/setup>`_.
420418

421419
macOS
422-
-----
420+
~~~~~
423421

424422
On macOS, ``platformdirs`` uses the standard Apple ``~/Library`` directories by default.
425423
See `Apple's File System Programming Guide
@@ -439,7 +437,7 @@ the Homebrew prefix as an additional path when ``multipath=True``.
439437
:no-index:
440438

441439
Windows
442-
-------
440+
~~~~~~~
443441

444442
On Windows, ``platformdirs`` uses the Shell Folder APIs to resolve directories.
445443
See `Microsoft's Known Folder documentation
@@ -534,7 +532,7 @@ Empty or whitespace-only values are ignored and the normal resolution applies.
534532
:no-index:
535533

536534
Linux / Unix
537-
------------
535+
~~~~~~~~~~~~
538536

539537
On Linux and other Unix-like systems, ``platformdirs`` follows the
540538
`XDG Base Directory Specification <https://specifications.freedesktop.org/basedir/latest/>`_.
@@ -571,7 +569,7 @@ the corresponding ``XDG_*_DIRS`` variable, joined by ``:``.
571569
:no-index:
572570

573571
Android
574-
-------
572+
~~~~~~~
575573

576574
On Android, ``platformdirs`` uses the app's private storage directories. The app's package
577575
folder (e.g. ``/data/data/com.example.app``) is detected via ``python-for-android`` or

0 commit comments

Comments
 (0)