Skip to content

Commit aa6e67c

Browse files
committed
Update docs
1 parent f902b0a commit aa6e67c

6 files changed

Lines changed: 14 additions & 3 deletions

File tree

docs/detection.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@
125125
| {func}`~is_opensuse` | 🦎 | {data}`~OPENSUSE` |
126126
| {func}`~is_openwrt` | 📶 | {data}`~OPENWRT` |
127127
| {func}`~is_oracle` | 🦴 | {data}`~ORACLE` |
128+
| {func}`~is_os400` | 🟦 | {data}`~OS400` |
128129
| {func}`~is_other_posix` | 🅟 | {data}`~OTHER_POSIX` |
129130
| {func}`~is_other_shells` || {data}`~OTHER_SHELLS` |
130131
| {func}`~is_parallels` || {data}`~PARALLELS` |
@@ -282,6 +283,7 @@
282283
.. autofunction:: extra_platforms.is_opensuse
283284
.. autofunction:: extra_platforms.is_openwrt
284285
.. autofunction:: extra_platforms.is_oracle
286+
.. autofunction:: extra_platforms.is_os400
285287
.. autofunction:: extra_platforms.is_parallels
286288
.. autofunction:: extra_platforms.is_pidora
287289
.. autofunction:: extra_platforms.is_powershell

docs/extra_platforms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:members:
88
:show-inheritance:
99
:undoc-members:
10-
:exclude-members: Agent, Architecture, CI, Group, Platform, Shell, Terminal, Trait, current_agent, current_architecture, current_ci, current_platform, current_shell, current_terminal, current_traits, extract_members, groups_from_ids, invalidate_caches, is_aarch64, is_aix, is_alacritty, is_alpine, is_altlinux, is_amzn, is_android, is_any_agent, is_any_architecture, is_any_arm, is_any_ci, is_any_mips, is_any_platform, is_any_shell, is_any_sparc, is_any_terminal, is_any_trait, is_any_windows, is_apple_terminal, is_arch, is_arch_32_bit, is_arch_64_bit, is_arm, is_armv5tel, is_armv6l, is_armv7l, is_armv8l, is_ash, is_azure_pipelines, is_bamboo, is_bash, is_big_endian, is_bourne_shells, is_bsd, is_bsd_not_macos, is_buildkite, is_buildroot, is_c_shells, is_cachyos, is_centos, is_circle_ci, is_cirrus_ci, is_claude_code, is_cline, is_cloudlinux, is_cmd, is_codebuild, is_contour, is_csh, is_cursor, is_cygwin, is_dash, is_debian, is_dragonfly_bsd, is_exherbo, is_fedora, is_fish, is_foot, is_freebsd, is_generic_linux, is_gentoo, is_ghostty, is_github_ci, is_gitlab_ci, is_gnome_terminal, is_gnu_screen, is_gpu_terminals, is_guix, is_guix_build, is_haiku, is_heroku_ci, is_hurd, is_hyper, is_i386, is_i586, is_i686, is_ibm_mainframe, is_ibm_powerkvm, is_illumos, is_iterm2, is_kali, is_kitty, is_konsole, is_ksh, is_kvmibm, is_linux, is_linux_layers, is_linux_like, is_linuxmint, is_little_endian, is_loongarch, is_loongarch64, is_macos, is_mageia, is_mandriva, is_manjaro, is_midnightbsd, is_mips, is_mips64, is_mips64el, is_mipsel, is_multiplexers, is_native_terminals, is_netbsd, is_nixos, is_nobara, is_nushell, is_openbsd, is_opensuse, is_openwrt, is_oracle, is_other_posix, is_other_shells, is_parallels, is_pidora, is_powerpc, is_powershell, is_ppc, is_ppc64, is_ppc64le, is_raspbian, is_rhel, is_rio, is_riscv, is_riscv32, is_riscv64, is_rocky, is_s390x, is_scientific, is_sh, is_slackware, is_sles, is_solaris, is_sparc, is_sparc64, is_sunos, is_system_v, is_tabby, is_tcsh, is_teamcity, is_tilix, is_tmux, is_travis_ci, is_tumbleweed, is_tuxedo, is_ubuntu, is_ultramarine, is_unix, is_unix_layers, is_unix_not_macos, is_unknown, is_unknown_agent, is_unknown_architecture, is_unknown_ci, is_unknown_platform, is_unknown_shell, is_unknown_terminal, is_void, is_vscode_terminal, is_wasm32, is_wasm64, is_web_terminals, is_webassembly, is_wezterm, is_windows, is_windows_shells, is_windows_terminal, is_wsl1, is_wsl2, is_x86, is_x86_64, is_xenserver, is_xonsh, is_xterm, is_zellij, is_zsh, reduce, traits_from_ids
10+
:exclude-members: Agent, Architecture, CI, Group, Platform, Shell, Terminal, Trait, current_agent, current_architecture, current_ci, current_platform, current_shell, current_terminal, current_traits, extract_members, groups_from_ids, invalidate_caches, is_aarch64, is_aix, is_alacritty, is_alpine, is_altlinux, is_amzn, is_android, is_any_agent, is_any_architecture, is_any_arm, is_any_ci, is_any_mips, is_any_platform, is_any_shell, is_any_sparc, is_any_terminal, is_any_trait, is_any_windows, is_apple_terminal, is_arch, is_arch_32_bit, is_arch_64_bit, is_arm, is_armv5tel, is_armv6l, is_armv7l, is_armv8l, is_ash, is_azure_pipelines, is_bamboo, is_bash, is_big_endian, is_bourne_shells, is_bsd, is_bsd_not_macos, is_buildkite, is_buildroot, is_c_shells, is_cachyos, is_centos, is_circle_ci, is_cirrus_ci, is_claude_code, is_cline, is_cloudlinux, is_cmd, is_codebuild, is_contour, is_csh, is_cursor, is_cygwin, is_dash, is_debian, is_dragonfly_bsd, is_exherbo, is_fedora, is_fish, is_foot, is_freebsd, is_generic_linux, is_gentoo, is_ghostty, is_github_ci, is_gitlab_ci, is_gnome_terminal, is_gnu_screen, is_gpu_terminals, is_guix, is_guix_build, is_haiku, is_heroku_ci, is_hurd, is_hyper, is_i386, is_i586, is_i686, is_ibm_mainframe, is_ibm_powerkvm, is_illumos, is_iterm2, is_kali, is_kitty, is_konsole, is_ksh, is_kvmibm, is_linux, is_linux_layers, is_linux_like, is_linuxmint, is_little_endian, is_loongarch, is_loongarch64, is_macos, is_mageia, is_mandriva, is_manjaro, is_midnightbsd, is_mips, is_mips64, is_mips64el, is_mipsel, is_multiplexers, is_native_terminals, is_netbsd, is_nixos, is_nobara, is_nushell, is_openbsd, is_opensuse, is_openwrt, is_oracle, is_os400, is_other_posix, is_other_shells, is_parallels, is_pidora, is_powerpc, is_powershell, is_ppc, is_ppc64, is_ppc64le, is_raspbian, is_rhel, is_rio, is_riscv, is_riscv32, is_riscv64, is_rocky, is_s390x, is_scientific, is_sh, is_slackware, is_sles, is_solaris, is_sparc, is_sparc64, is_sunos, is_system_v, is_tabby, is_tcsh, is_teamcity, is_tilix, is_tmux, is_travis_ci, is_tumbleweed, is_tuxedo, is_ubuntu, is_ultramarine, is_unix, is_unix_layers, is_unix_not_macos, is_unknown, is_unknown_agent, is_unknown_architecture, is_unknown_ci, is_unknown_platform, is_unknown_shell, is_unknown_terminal, is_void, is_vscode_terminal, is_wasm32, is_wasm64, is_web_terminals, is_webassembly, is_wezterm, is_windows, is_windows_shells, is_windows_terminal, is_wsl1, is_wsl2, is_x86, is_x86_64, is_xenserver, is_xonsh, is_xterm, is_zellij, is_zsh, reduce, traits_from_ids
1111
```
1212

1313
<!-- extra-platforms-automodule-end -->

docs/platforms.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ Platform(id='macos', name='macOS')
8787
| 🦎 | {data}`~OPENSUSE` | openSUSE | {func}`~is_opensuse` |
8888
| 📶 | {data}`~OPENWRT` | OpenWrt | {func}`~is_openwrt` |
8989
| 🦴 | {data}`~ORACLE` | Oracle Linux | {func}`~is_oracle` |
90+
| 🟦 | {data}`~OS400` | IBM i | {func}`~is_os400` |
9091
|| {data}`~PARALLELS` | Parallels | {func}`~is_parallels` |
9192
| 🍓 | {data}`~PIDORA` | Pidora | {func}`~is_pidora` |
9293
| 🍓 | {data}`~RASPBIAN` | Raspbian | {func}`~is_raspbian` |
@@ -164,9 +165,9 @@ sankey-beta
164165
ALL_PLATFORMS,LINUX,41
165166
ALL_PLATFORMS,BSD,7
166167
ALL_PLATFORMS,SYSTEM_V,3
168+
ALL_PLATFORMS,UNIX_LAYERS,2
167169
ALL_PLATFORMS,OTHER_POSIX,2
168170
ALL_PLATFORMS,LINUX_LAYERS,2
169-
ALL_PLATFORMS,UNIX_LAYERS,1
170171
ALL_PLATFORMS,ALL_WINDOWS,1
171172
LINUX,ALPINE,1
172173
LINUX,ALTLINUX,1
@@ -219,11 +220,12 @@ BSD,SUNOS,1
219220
SYSTEM_V,AIX,1
220221
SYSTEM_V,ILLUMOS,1
221222
SYSTEM_V,SOLARIS,1
223+
UNIX_LAYERS,CYGWIN,1
224+
UNIX_LAYERS,OS400,1
222225
OTHER_POSIX,HAIKU,1
223226
OTHER_POSIX,HURD,1
224227
LINUX_LAYERS,WSL1,1
225228
LINUX_LAYERS,WSL2,1
226-
UNIX_LAYERS,CYGWIN,1
227229
ALL_WINDOWS,WINDOWS,1
228230
```
229231

@@ -241,6 +243,7 @@ mindmap
241243
((⚙️ ALL_PLATFORMS))
242244
)≛ UNIX_LAYERS(
243245
(Ͼ CYGWIN)
246+
(🟦 OS400)
244247
)𝐕 SYSTEM_V(
245248
(➿ AIX)
246249
(🔥 ILLUMOS)
@@ -359,6 +362,7 @@ mindmap
359362
.. autodata:: extra_platforms.OPENSUSE
360363
.. autodata:: extra_platforms.OPENWRT
361364
.. autodata:: extra_platforms.ORACLE
365+
.. autodata:: extra_platforms.OS400
362366
.. autodata:: extra_platforms.PARALLELS
363367
.. autodata:: extra_platforms.PIDORA
364368
.. autodata:: extra_platforms.RASPBIAN

docs/pytest.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ def test_not_in_github_actions():
190190
| {deco}`~pytest.skip_opensuse` | {deco}`~pytest.unless_opensuse` | 🦎 | {data}`~OPENSUSE` |
191191
| {deco}`~pytest.skip_openwrt` | {deco}`~pytest.unless_openwrt` | 📶 | {data}`~OPENWRT` |
192192
| {deco}`~pytest.skip_oracle` | {deco}`~pytest.unless_oracle` | 🦴 | {data}`~ORACLE` |
193+
| {deco}`~pytest.skip_os400` | {deco}`~pytest.unless_os400` | 🟦 | {data}`~OS400` |
193194
| {deco}`~pytest.skip_other_posix` | {deco}`~pytest.unless_other_posix` | 🅟 | {data}`~OTHER_POSIX` |
194195
| {deco}`~pytest.skip_other_shells` | {deco}`~pytest.unless_other_shells` || {data}`~OTHER_SHELLS` |
195196
| {deco}`~pytest.skip_parallels` | {deco}`~pytest.unless_parallels` || {data}`~PARALLELS` |
@@ -374,6 +375,7 @@ def test_not_in_github_actions():
374375
.. autodecorator:: extra_platforms.pytest.skip_opensuse
375376
.. autodecorator:: extra_platforms.pytest.skip_openwrt
376377
.. autodecorator:: extra_platforms.pytest.skip_oracle
378+
.. autodecorator:: extra_platforms.pytest.skip_os400
377379
.. autodecorator:: extra_platforms.pytest.skip_other_posix
378380
.. autodecorator:: extra_platforms.pytest.skip_other_shells
379381
.. autodecorator:: extra_platforms.pytest.skip_parallels
@@ -555,6 +557,7 @@ def test_not_in_github_actions():
555557
.. autodecorator:: extra_platforms.pytest.unless_opensuse
556558
.. autodecorator:: extra_platforms.pytest.unless_openwrt
557559
.. autodecorator:: extra_platforms.pytest.unless_oracle
560+
.. autodecorator:: extra_platforms.pytest.unless_os400
558561
.. autodecorator:: extra_platforms.pytest.unless_other_posix
559562
.. autodecorator:: extra_platforms.pytest.unless_other_shells
560563
.. autodecorator:: extra_platforms.pytest.unless_parallels

docs/trait.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,7 @@ All recognized traits and their properties:
217217
| 🦎 | {data}`~OPENSUSE` | openSUSE | {func}`~is_opensuse` | Platform |
218218
| 📶 | {data}`~OPENWRT` | OpenWrt | {func}`~is_openwrt` | Platform |
219219
| 🦴 | {data}`~ORACLE` | Oracle Linux | {func}`~is_oracle` | Platform |
220+
| 🟦 | {data}`~OS400` | IBM i | {func}`~is_os400` | Platform |
220221
|| {data}`~PARALLELS` | Parallels | {func}`~is_parallels` | Platform |
221222
| 🍓 | {data}`~PIDORA` | Pidora | {func}`~is_pidora` | Platform |
222223
| 🔷 | {data}`~POWERSHELL` | PowerShell | {func}`~is_powershell` | Shell |

readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,7 @@ mindmap
305305
((⚙️ ALL_PLATFORMS))
306306
)≛ UNIX_LAYERS(
307307
(Ͼ CYGWIN)
308+
(🟦 OS400)
308309
)𝐕 SYSTEM_V(
309310
(➿ AIX)
310311
(🔥 ILLUMOS)

0 commit comments

Comments
 (0)