mkdocstrings-matlab 2.1.1__tar.gz → 2.1.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of mkdocstrings-matlab might be problematic. Click here for more details.
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.github/workflows/docs.yaml +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.github/workflows/qualify.yaml +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.github/workflows/release.yaml +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.gitignore +3 -0
- mkdocstrings_matlab-2.1.2/.rumdl.toml +72 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/PKG-INFO +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/api.md +0 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/index.md +3 -3
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/license-page.md +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+module/module.md +2 -2
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mymembers/mymembers.md +2 -2
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mynamespace/mynamespace.md +1 -1
- mkdocstrings_matlab-2.1.2/docs/src/snippets/+mynamespace/readme.md +1 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+undocumented/undocumented.md +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/configuration/docstrings.md +24 -29
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/configuration/general.md +5 -6
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/configuration/headings.md +21 -19
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/configuration/members.md +22 -24
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/configuration/signatures.md +1 -2
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/docstrings/google.md +3 -3
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/docstrings/numpy.md +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/docstrings/sphinx.md +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/global.md +1 -4
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/index.md +13 -11
- mkdocstrings_matlab-2.1.2/prek.toml +69 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/pyproject.toml +2 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/languages/en.html.jinja +1 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/__init__.py +30 -30
- mkdocstrings_matlab-2.1.1/test/snapshots/external/2975dcb46314978ae7493bf46eaadfab9b542f0eb6ec9fc9c6fed21823207a47.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/04b032ce769d60ded25363797b4ff13b11234ab177cb6af364f26d09e5d77fcd.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/1271356810fec6c4101ad12fc1cecce005af3908fa58b2268f82e721a7d95470.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/1b18af6fbb5dbba50bd00ceda93037d442418bd7b53f49781c46dca738863764.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/1cb3fe2e2034393472344d8aec0e370a4f6b85aebbe192d5408c49a963c51ffd.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/1ea43f2df76d76edf4e0fa4a58a13569992175178c89e589cdecb8945a7f2f73.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/3e7bbbc8686f6065cc8f4f1dbb634fa5d6ee7e7d5e3ad0cd38c2506b12669dc2.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/2dec9ad9ccd99ab764034edc8d9864a5f5c55d97695b6cd95da69aac409afc68.html +2 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/8859bb5b1400ba803ba56893be9d025bfdc3609d9355ab7700f26f9401a953b9.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/2edd56b7576d70af5351de9a19c3a2229e7d8e4cd6b54a5cb63abe78085c8f53.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/f1ecd737a1f02236812af6006232e3d875973a50ad81e2f2894e72f1ade28a05.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/37ded686118e86c7720363d2f7a1dadf5c56b4db2d7cd4e0a4e56d7bee887f78.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/91195fc8935832152c7b7b4aca79e544a89ee2c332f5b50b891eeb54cfe6fda7.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/38349afd485e12ac7a339bbc03a035f779a0eb202dab95d7d75ab65d42660a3d.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/16eb3b05bc2ccf37e1096fac8279fe895091effa2636345c1be4fbecdb6adf62.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/3935b37799049ae2862cd4f9ddf25183cfeb33613dd85938d18f8af3ccbf05f9.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/59b971fe585db1eeb6ebd71b8b0796fc6d5de935a7899bac8ebad97c78fc6aab.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/3a3b73b4fa1038fb64e8e938790554bcd9f263e387e5afe8fb1debb3eccb9425.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/d75158ca9780ab302bf908d8f5e88e9359d2fe463f95edb4a88a8aa129c26166.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/45b2feb7ffc1eeb8b192e3c3af497ada25a2db60fbbed4d5466bc2f0ce11767f.html +2 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/bfe6aac43518c9b1d2bc6983909bc73ea8494c4019d022b90f4fb331329411a5.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/53f388f803cc3a0860d5a73127df1295b6d97f958f9bc890aaee0b9a5f1ca3c6.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/24699e77e03bd42734b4fbf167a6d6943710eeecdf0dccb9167a59d8c84b58ba.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/60f32a129c3f96b3eae0645c46c1e22eda595dd0bd7e912acbf4c77a119024e2.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/8a8ca4c46fa030c0a221a1e0b6d2d79915c38b22983dad87bd21b7d1d3d8283a.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/66391630c6f430071cd00ddabf23501f24077c00423811091b5cc2ca40096e02.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/53e17e775ba6328e5f6156d0e9bf5046445429035b2ac88bd386f1e6fee3b3ad.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/67e633fdc5fd062bc5b95f022f3792086eccd13ed7f121bb8238caeac12dc66d.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/59f5ab29bec8e854758cfc28ec006ed053ce87f564ba82b622de511b97b6321b.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/67ffdd88d1c249fae0e47b1985702d1a7900dbd6072015345133e9267ee969b7.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/80040c17d57cb0d4ecfba147ceafba05533f9e1bfd4e50e3b42c19b3b1541728.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/6b5176c79aca96d32f6c337e3ffb26072410568edf0b132208c8bfa9c8af5569.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/a08c29aaa6d5cf10f45973626d7a8802cf03720f01d4fc65b734c3c05b61581e.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/7dfe15f2fd74c2ce70df12d442de782f203728349f1d5d6f129c394dd19b05e8.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/ba50d6df9b5c526a6f8ee86899ac2cea2d4ac6545781120a7b62f957795523b9.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/8cc61621b351df62a1fb8038d7cebd4aafb202bcd36c223b307eeb0362d712a9.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/bdcf04b60979ab3b3f98bf28a4f3a0e64b8f59378cd3a494254ddb5b34aa8723.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/91d51653b7508b8b023d98003e65f6d5bc00f1344aaad5fe20e9c713e37b2eec.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/78e673da931c6a5c7e53670bf818f5de137789794a4bcdf1b50ac6d79bef76c6.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/931dd0e2f36d987f73522b6f5ddae8cdd207a272ba5ec8f4038879560057286d.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/9976aa19ad371ecbb799e06a20c4d960ccdae092b272842d750ac9eb81881a6f.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/96a12ab150b18fc394238660d510059a938da727ed8ec77da49e0f6d3ada96c8.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/76d0eae1aa8aca4e2894886ad9761f99aca02ba8198ed4a08559acc6f44f5601.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/9a4dd0c2e04aa9207777f4b294246ae96bb9ea911e3c689b0f481c7d8949321b.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/07d9dc5f8576ad41ba257a4ef1aa16c2f3594175315549cb7c8054a80f3fea95.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/9eea5cee31dee1a29e7b4eb2081963c613aca8475915bec6a27f50bacc493fb2.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/201baee4ccea3f5d43839d64f3168805e525a49fbddbd779c5f2cc162e4a29d3.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/a534e2d7452cc3090b5f1d916ddede9535e4f7bcf60571150162eefd5d6a67fb.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/5cb294dea3158a074d83581eda14155338e58f53aa79cd6b0efd3d70a6100e2e.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/aa5ac519d46fde75c0025288b1d0d027ff3ede0bc250392640139a254e7106dc.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/115dbb6ef57775f39a24f719fca6ff43b94fd8f3e2a78932b57a8489e1285dd6.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/b80bae05c4af7796cb702ceb61a485048aabb2da68ea34870041b58b38e30b59.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/433d68533719fce6172bd5088716268be75a7fe1e0ef8fdf8dd778f149071c27.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/bfe8b203819c24159fcdff05760a1fc72806608a21591ffcfd460416f1379282.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/da2217148ea374a77382f93113fda3bb9af792b545ac2b0bab0be6b1bba999a1.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/c26918db1e083fdde7ea5b6a224f54613061774f9b4c27df7f7b0fbf48ca9dec.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/93f73cc298dad3b3e00c5084092facc3f1e720caaa34477ac76ae9fa7f6f4092.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/ca187a0f64e01c62dc886553af501c46f5775745f61e8d971edf718f4c2338a9.html +1 -1
- mkdocstrings_matlab-2.1.1/test/snapshots/external/7a69e568f6ba6d9e0f75226683c8e0550f2e7f5bcc95e158323d5b599598b153.html → mkdocstrings_matlab-2.1.2/test/snapshots/external/e5253214f3b19e86713553dff359e350561b9e89cec80db6a8a9a7f6ba10c8cb.html +1 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_end_to_end.py +6 -0
- mkdocstrings_matlab-2.1.1/.pre-commit-config.yaml +0 -37
- mkdocstrings_matlab-2.1.1/docs/src/snippets/+mynamespace/readme.md +0 -1
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.github/CODEOWNERS +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.github/CONTRIBUTING.md +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.github/FUNDING.yml +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/.github/renovate.json5 +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/LICENSE +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/README.md +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/debug.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/contributing.md +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/credits.md +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/debug.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/favicon.png +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/logo.png +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/overrides/main.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/overrides/partials/toc-item.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+module/+submodule/Contents.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+module/+submodule/subfunction.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+module/aClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+module/do_something.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+module/readme.md +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mymembers/BaseClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mymembers/Contents.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mymembers/ThisClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mymembers/this_function.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mynamespace/classA.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mynamespace/classB.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mynamespace/myscript.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mynamespace/typed_class_property.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mynamespace/typed_function.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+undocumented/ClassWithoutDocstring.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+undocumented/function_with_docstring.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+undocumented/function_without_docstring.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/Class.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/OtherClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/Thing.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/do_output.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/do_something.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/do_varargin.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/myClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/myParent.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/myfunction.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/print_hello.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/subdir/Contents.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/subdir/subsubdir/README.md +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/subdir/subsubdir/nested.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/stylesheets/extra.css +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/logo.png +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/mkdocs.yml +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/__init__.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/config.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/handler.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/py.typed +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/rendering.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/attributes.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/backlinks.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/children.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/class.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/admonition.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/classes.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/examples.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/functions.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/input_arguments.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/name_value_arguments.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/output_arguments.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/expression.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/folder.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/function.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/language.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/languages/ja.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/languages/zh.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/property.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/script.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/signature.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/style.css +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/summary/classes.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/summary/functions.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/src/mkdocstrings_handlers/matlab/templates/material/summary.html.jinja +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/__init__.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/conftest.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/docs/.gitkeep +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/+moduleNamespace/+internal/hidden_function.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/+moduleNamespace/Contents.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/+moduleNamespace/namespaceClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/+moduleNamespace/namespace_function.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/@classFolder/classFolder.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/@classFolder/method.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/@classFolder/readme.md +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/class_property.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/forced_docstring.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/moduleClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/module_arguments.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/module_function.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/private/private_function.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/fixture/subClass.m +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/helpers.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/.gitignore +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/0113373833f7ae4159513dfa1df71c9bbc70ef9075b82cc724fe38f762930b01.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/01ca7e807eab40f9b593ae59c8d2b7265f354b82e9882cf36e8cb9a33ea0c5d3.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/0d03d2fd7958cb2362ce042bb599d7836be756e52d700c7fb5b5860d8a5f2857.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/0dc4897f65cf3ad9d09efdd62887e6216d6c644a1bc155ebc90b10ec8c9bf199.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/0f17233207bf629c41ad74ae2cf33f1c9e4ce193a01bd883b2c6e6c1b0d06d52.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/0ff0c6a91b4db0f807d50eeae8122934c42535120f52e16605d77ec8da6617e2.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/14375fc2155081fc0fdc83ab40b4547aed9bb9e41fe7148f29c1cc0516736449.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/1467747d65f31dba9f3c05fffab31d6453bc934801613ffc07ffef11b3d29f3d.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/15e3200b589c43b9775ed6d66e644c79c4b1506f90b5b6f1ce4847f2542f898e.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/16747e11c170624c5d2c4333e677390d7bd259d39a3dd47aff05ed9e714f86cb.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/16c98a39c8e36cedbaa5a2dabf5f2fd85a147a677dcfe6e3b4881035133f273e.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/18cf87b261c0f060569498e06395603c85cc45664bfe21dd8e944d3cba6485cd.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/1ddca1666155397314abf6f06919a7349182859c9eb458f0f83a463f863fe901.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/1e0705cd6b2a3a180c5461733c4b156dc4a23672656c6eecc1fc13fc230c54c6.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/1ea600ce2fa18c0c15248f9026037b02fa132f36081bfbad0ab70ff521d98449.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/1f4d5eacc78f3936fd4738808c0a7af475539ae32f3bb695838b07ccb436ca7d.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/280e624c7a5c7978e726c5d2c94d3aa705a745d299274091050a8deac2e482c1.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/28d3b688c6030da33067d0eae8a2ca0665807cddb5a520a104fbf3b75f68ab2b.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/2947fe8a21dbfd6d351f8553bb629b3a85572ce39af63b48cf360b2e4341ad41.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/2b014ab43c8796cbb2b4ab46848a8d77d04b6e4f2884f2873b7e9019f64585fc.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/2be6e2739d8d93234d8e6f008a5f6abf91980eb80b97ce38587ccabf1592da5f.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/2bf2b59832bb76db239baf470d2ef9b133bdbe9c5a80a64ddeaaaf7731395a69.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/2cb6f36cfecd9b28823affb4f2d97dc12db60ca9fe364f035892862896dd1f8d.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/32281dd57f021e2618feead3439c73fcfb9cac29dd16b05d21f75889cfa5a8bf.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/3307c670266ed2b855317aa5b0643fdb198d2b840d90eb4aefd534930a87a6ed.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/368f6d810e7341e6eba76e835cc73b55df930825525e658c4f56f9d83a0f53ce.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/38c328a8d47b8acdb07d2d7411c5aa30fcc7fb7d774a100a2d1e36587d23557e.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/3d399be45fe4a886065ff799582da58044adb732c0e8dddf5717bf7c082903c9.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/494935f3f4ff019b5d069cbada13bf19961792d368436fed06507112fb9d7973.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/4d21c060520b1dca536772449ef3aa9207466e981a5ec06ea245cdc0ec2dd469.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/4fc866308f8bb2788845391857af88e8de14e32369b1d9195ec14807fd63c909.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/510cec1edd589e57b603a4272aa9746e2ce9ea695cbaeab2d5c0b6916d96df26.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/54d97c82cd988fcbe05cee31e67aa102ada34a9512c3e1ac387fc90b0c774c17.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/568c966787a03fb6c613c965b40b19765ec29b5278d4516151a77ac89129018e.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/56d44149e87990cadcfb34971a0b4a8edf03aed77f3e1dd1bbc127fa4cdcc018.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/58231283a21b6e91f24da36f96734a8837d15de724d7a3a3d513e2d1da75fb71.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/5958a350dfbc63d6bb36da030bb2ebad55fab33d3da698dae588e6857551939a.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/59864ded4f860613a523d3551eb53481c0d6fce02add797aecdeb59332009a74.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/5c46f46252e44c72c52d7a9112c50db70c899a5b0fd8cd45a767b6817c42e16a.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/5dcc553300dd89d50f529528ce5ad572123de9d774dafe3887891523d026ba05.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/5e4aabb64b6b5bb1212409e6b0a9abdaa951f447dbd28fcb967ee18b8f5259a2.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/5ef4a55b645c1d51eb06811aaced8c0f216ac90e9e71dd6c0846c53414992687.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/61dc29181a6246e0748ea1e9d081a51b233672fc158c528b7b10111cd3bead71.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/6225737a62d7edf781ba684b15fe7b273a9e7ee7ecc2733b3d54eb02979086fb.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/6340ad77d61acadbe4b13c250e2bf0327f8b2a0a388ea196596fde33d1470941.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/65a020088c6492b445c0cd7be6b6837581680d9d99d12225cb8e6a8bd042a65e.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/678233da351b00ae82acb3d31456581595679c49b33d5166db5ec84b0bd80e68.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/69a8fb86a5a0915046b5041aa00a4c056adce9c89be38a107dbc0ed71626376a.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/6fe7ef6969cc73c437718c7a2c1ff221ba7971febcea9215835153ef26211b26.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/70ab3907fed1e31504810cccb8896d7365a0b91d385e13e14f2334e8882747e9.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/7130f7ac88bea463f92cd906e7a86637182affbc4c4afbf64d8b56b5e4f4e675.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/73f9d2b8adc9d9a8c3e4cc5f677d060c10f0468d3cf3628e73443939f0c732ed.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/7589cda3f7292466252ef8f5a337d2d4e1903d49f78ecd5f0c9cf1025a97cbcb.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/75ad88fd5e72327cb28027b7d164efc2e399469f2213226b6766c7efaafb8842.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/7a2a67fdcde4fe2c4323547a989de7f1737708cd8c8bbdb2c453aaa82411756c.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/7a2d79298680a15e31f5aece6b3381a4d468b63585bd465066a83602cdcf6414.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/7a881f20f14c5b9e2209fa65aa83b4d289d54ce54d868e547e30d33751bf0ae6.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/7f035d40c198a273da851a00db129f9ddba503f1903f26b06c35cc1406b99091.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/80a90ec7091286dd3dfa53af8ec9e01e7621bce8b7b8bdd2fa0b7eba0395d861.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/81306c9d9550c48b153581b06ba244614a6f71bb88f86d434ae11e711acc7239.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/81ddc08441fb3b595ad7e7432cfdd7f22d1a845ecaa83a92365861a9437e7889.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/8aeecc7e575cc87bbd38c31dfc434eae3b909d57591e1cc8ed42e4ad41580db5.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/902d6ee7213689dd9e5d3b8d02c6b88dd8ce983ffeb35ff35dfc9502ac334494.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/92b0fb53d6709aa5d03ac5e52ec2ffd72beb800b477ef5bd00f99b0bf42cdacc.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/93031b69f5376fe15fc40f23b5b6b96bdb1eb90865bd011b753907701d8fe85b.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/935e0403546446187fff8e2123c8176774d7574744e1fbca3018ff96c5382601.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/97ab1c5513facee5191c1cbb0ca7b59e78731d43e309a4a3f0944ea4125b0e21.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/9bdbcd111c2cbc8e5784a5f2ee87280b90c6ef0719310adffc8e9b789e30bc70.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/9ee768f85eab2401837ff3e774dd4735ab445c1b1eb8dd9e7bb16523f519b312.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/a43048052005b3d94d68808d61b78b27c3880f937dde2aa91d379e28712dbd6a.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/aa7d5b7fec2d129bb01ed89046e3e2407c41d44eceefacce091dfd1f19dbff47.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/abc017eefa9d8b2d156af6d516b739206bd5e4344d5edf905cf9337d96cfba2b.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/abe379fb91f0b9e47a3cbe3666a7454760db5fa6315892f246a548fc7c341566.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/acc894b5bfdf4781f25cafe408161b211039453fe003c9c59a1f79b0792ec9cf.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/b3137443bca9ed66d920e6f03733100515badc2dd58c3a2716ffe03b57127135.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/b360046d413f370560fe1b00820fdff478e8a2a6b04d790307e70417be65642d.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/b42f328b72ea25f102fcb55aea92ef17ccc141634ef8f8b0589d61a8f9705f6f.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/b8a649a0b6546f9fdef2246efa40e7e09b7a746f4d334c4d45a2f8e65452b567.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/ba986803c9e1967a091f0d4f7a27438f0787232ed7a29eceda5aa0f9339bf5c2.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/bbd65348654343e84195f6989383e353add0433c59dc6cbc7320e877fde870a1.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/bc31b4ef3ece371662b08a08550b8616d28ef72b7c90d5140bee0f958671f351.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/bc5594bd8f7cc725bf0fa0e5fe518c934c77f76dffa8be532c1666831fda2150.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/bcbbdfbe7a0fe5879730f4bf35c9280a42b2c46d539c77b74bfb6fc13fe57ba9.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/c0e27b1c2fd2aa14da003992b580eeab08e6b177fcb198a0f5a07ee07786d6e8.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/c0f8336de59689cdd760a63b590a1b697f201292390c1ef0dd458db089ef0d89.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/c3f4d95bee252c789fd20edee59c72946a73d6c38af31d6160ecd41c2a88bfc9.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/cd717d1020d418a13ce24e76d9b69144c9685e0cdddf1670bfa4c9351497c973.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/cd9476a4d9e90bf39388038903ee5c1637ae11ac1091c1ef24e46368a9827d69.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/cf1a3f1181ca0e5684a78f9fbb57d955474d4459065049c8215480f49d2c9d6b.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/d33960f666c96bfa735026ae76717e35fbd07a01a234760cae076f9522bd8eee.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/d3f96b8d107b5fcad4d5db82a7571b2f2362dcebff9c33bf75becfbf6986726c.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/da2df1c0e3d9153d066ffeaea8efaba94b105a9867bbaaefe4033b118928a401.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/da803de751498bd523425e9a9c9777b227c3cca47ec613382b909452113f2664.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/e6cbaad043a264b684d67fab03a8768220122dc785f377d94392149dd3b3749a.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/e97601b5c8d9c4bb233b5aa2d45e4b83135aec6cf44f20f920433c1aaf5f7008.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/eff17893c2f4e2c4b3ab1f234b920d38b0788681f98abd8c1d11d525e48b0077.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/f231cf0535e4d70669e6d125f4f8416cf4c39161d7ce10c420868ea93153f56e.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/f55d6bb2445a1650f841f5d72bcba0d954096c75baa3e8c2b21e2dcf6ad43d58.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/snapshots/external/f5a8a9d05580b087ccdffbd2c287a27e97df5cc5a7b98082d38fb3a406481597.html +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_config.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_handler.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_handler_additional.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_init.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_rendering.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_rendering_additional.py +0 -0
- {mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/test/test_rendering_advanced.py +0 -0
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# rumdl configuration file
|
|
2
|
+
|
|
3
|
+
# Inherit settings from another config file (relative to this file's directory)
|
|
4
|
+
# extends = "../base.rumdl.toml"
|
|
5
|
+
|
|
6
|
+
# Global configuration options
|
|
7
|
+
[global]
|
|
8
|
+
|
|
9
|
+
flavor = "mkdocs"
|
|
10
|
+
|
|
11
|
+
# List of rules to disable (uncomment and modify as needed)
|
|
12
|
+
disable = ["MD013", "MD033", "MD041"]
|
|
13
|
+
|
|
14
|
+
# List of rules to enable exclusively (replaces defaults; only these rules will run)
|
|
15
|
+
# enable = ["MD001", "MD003", "MD004"]
|
|
16
|
+
|
|
17
|
+
# Additional rules to enable on top of defaults (additive, does not replace)
|
|
18
|
+
# Use this to activate opt-in rules like MD060, MD063, MD072, MD073, MD074
|
|
19
|
+
# extend-enable = ["MD060", "MD063"]
|
|
20
|
+
|
|
21
|
+
# Additional rules to disable on top of the disable list (additive)
|
|
22
|
+
# extend-disable = ["MD041"]
|
|
23
|
+
|
|
24
|
+
# List of file/directory patterns to include for linting (if provided, only these will be linted)
|
|
25
|
+
# include = [
|
|
26
|
+
# "docs/*.md",
|
|
27
|
+
# "src/**/*.md",
|
|
28
|
+
# "README.md"
|
|
29
|
+
# ]
|
|
30
|
+
|
|
31
|
+
# List of file/directory patterns to exclude from linting
|
|
32
|
+
exclude = [
|
|
33
|
+
# Common directories to exclude
|
|
34
|
+
".git",
|
|
35
|
+
".github",
|
|
36
|
+
"node_modules",
|
|
37
|
+
"vendor",
|
|
38
|
+
"dist",
|
|
39
|
+
"build",
|
|
40
|
+
|
|
41
|
+
# Specific files or patterns
|
|
42
|
+
"CHANGELOG.md",
|
|
43
|
+
"LICENSE.md",
|
|
44
|
+
]
|
|
45
|
+
|
|
46
|
+
# Respect .gitignore files when scanning directories (default: true)
|
|
47
|
+
respect-gitignore = true
|
|
48
|
+
|
|
49
|
+
# Markdown flavor/dialect (uncomment to enable)
|
|
50
|
+
# Options: standard (default), gfm, commonmark, mkdocs, mdx, pandoc, quarto, obsidian, kramdown, azure_devops, myst, mdg
|
|
51
|
+
# flavor = "mkdocs"
|
|
52
|
+
|
|
53
|
+
# Rule-specific configurations (uncomment and modify as needed)
|
|
54
|
+
|
|
55
|
+
# [MD003]
|
|
56
|
+
# style = "atx" # Heading style (atx, atx_closed, setext)
|
|
57
|
+
|
|
58
|
+
# [MD004]
|
|
59
|
+
# style = "asterisk" # Unordered list style (asterisk, plus, dash, consistent)
|
|
60
|
+
|
|
61
|
+
# [MD007]
|
|
62
|
+
# indent = 4 # Unordered list indentation
|
|
63
|
+
|
|
64
|
+
# [MD013]
|
|
65
|
+
# line-length = 100 # Line length
|
|
66
|
+
# code-blocks = false # Exclude code blocks from line length check
|
|
67
|
+
# tables = false # Exclude tables from line length check
|
|
68
|
+
# headings = true # Include headings in line length check
|
|
69
|
+
|
|
70
|
+
# [MD044]
|
|
71
|
+
# names = ["rumdl", "Markdown", "GitHub"] # Proper names that should be capitalized correctly
|
|
72
|
+
# code-blocks = false # Check code blocks for proper names (default: false, skips code blocks)
|
|
@@ -5,7 +5,7 @@ hide:
|
|
|
5
5
|
|
|
6
6
|
--8<-- "README.md:header"
|
|
7
7
|
|
|
8
|
-
## Preview
|
|
8
|
+
## Preview
|
|
9
9
|
|
|
10
10
|
Let's us quickly see how auto-documentation works with mkdocstrings-matlab:
|
|
11
11
|
|
|
@@ -38,10 +38,10 @@ Given the function above, the rendered documentation here is created from the fo
|
|
|
38
38
|
|
|
39
39
|
!!! note
|
|
40
40
|
|
|
41
|
-
Syntax highlighting of argument blocks will be incorrect with the default configuration due to the outdated MATLAB lexer in [Pygments](https://github.com/pygments/pygments/) and will be resolved after [our PR](https://github.com/pygments/pygments/pull/2887) is merged.
|
|
41
|
+
Syntax highlighting of argument blocks will be incorrect with the default configuration due to the outdated MATLAB lexer in [Pygments](https://github.com/pygments/pygments/) and will be resolved after [our PR](https://github.com/pygments/pygments/pull/2887) is merged.
|
|
42
42
|
|
|
43
43
|
In the meantime, the correct syntax highlighing can be configured by adding our branch as the dependency in `pyproject.toml`
|
|
44
|
-
|
|
44
|
+
|
|
45
45
|
```toml title="pyproject.toml"
|
|
46
46
|
dependencies = [
|
|
47
47
|
"pygments @ git+https://github.com/watermarkhu/pygments.git@matlab",
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
This is the docstring for mynamespace.
|
{mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/configuration/docstrings.md
RENAMED
|
@@ -51,13 +51,13 @@ Possible values:
|
|
|
51
51
|
```matlab
|
|
52
52
|
function message = greet(name)
|
|
53
53
|
% Greet someone.
|
|
54
|
-
%
|
|
54
|
+
%
|
|
55
55
|
% Parameters:
|
|
56
56
|
% name: The name of the person to greet.
|
|
57
|
-
%
|
|
57
|
+
%
|
|
58
58
|
% Returns:
|
|
59
59
|
% message: A greeting message.
|
|
60
|
-
|
|
60
|
+
|
|
61
61
|
message = sprintf("Hello %s!", name)
|
|
62
62
|
end
|
|
63
63
|
```
|
|
@@ -67,17 +67,17 @@ Possible values:
|
|
|
67
67
|
```matlab
|
|
68
68
|
function message = greet(name)
|
|
69
69
|
% Greet someone.
|
|
70
|
-
%
|
|
70
|
+
%
|
|
71
71
|
% Parameters
|
|
72
72
|
% ----------
|
|
73
73
|
% name
|
|
74
74
|
% The name of the person to greet.
|
|
75
|
-
%
|
|
75
|
+
%
|
|
76
76
|
% Returns
|
|
77
77
|
% -------
|
|
78
78
|
% message
|
|
79
79
|
% A greeting message.
|
|
80
|
-
|
|
80
|
+
|
|
81
81
|
message = sprintf("Hello %s!", name)
|
|
82
82
|
end
|
|
83
83
|
```
|
|
@@ -87,10 +87,10 @@ Possible values:
|
|
|
87
87
|
```matlab
|
|
88
88
|
function message = greet(name)
|
|
89
89
|
% Greet someone.
|
|
90
|
-
%
|
|
90
|
+
%
|
|
91
91
|
% :param name: The name of the person to greet.
|
|
92
92
|
% :return: A greeting message.
|
|
93
|
-
|
|
93
|
+
|
|
94
94
|
message = sprintf("Hello %s!", name)
|
|
95
95
|
end
|
|
96
96
|
```
|
|
@@ -107,7 +107,7 @@ The options for the docstring parser.
|
|
|
107
107
|
|
|
108
108
|
The Sphinx style does not offer any option.
|
|
109
109
|
|
|
110
|
-
Most of the options in the linked pages will not have an effect to mkdocstrings-matlab, since here the objects are mocked as Python objects are docstrings are injected into the mocked objects.
|
|
110
|
+
Most of the options in the linked pages will not have an effect to mkdocstrings-matlab, since here the objects are mocked as Python objects are docstrings are injected into the mocked objects.
|
|
111
111
|
|
|
112
112
|
=== "mkdocs.yml"
|
|
113
113
|
|
|
@@ -176,7 +176,6 @@ Sections are parsed as structured data and can therefore be rendered in differen
|
|
|
176
176
|
|
|
177
177
|
???+ preview
|
|
178
178
|
|
|
179
|
-
|
|
180
179
|
=== "Table"
|
|
181
180
|
|
|
182
181
|
Tables work well when you have lots of items with short names, type annotations, descriptions, etc.. With longer strings, the columns risk getting squished horizontally. In that case, the Spacy tables can help.
|
|
@@ -233,25 +232,24 @@ Sections are parsed as structured data and can therefore be rendered in differen
|
|
|
233
232
|
|
|
234
233
|
Whether to load inputs and output parameters based on argument validation blocks.
|
|
235
234
|
|
|
236
|
-
Similarly to Python, MATLAB is by default not a typed language. Function and method arguments are dynamically typed, in most cases. This provides flexibility, but is generally bad behavior if the code is meant for production or is intended to be exposed as an API.
|
|
235
|
+
Similarly to Python, MATLAB is by default not a typed language. Function and method arguments are dynamically typed, in most cases. This provides flexibility, but is generally bad behavior if the code is meant for production or is intended to be exposed as an API.
|
|
237
236
|
|
|
238
|
-
In MATLAB R2019b the concept of [Argument Definitions](https://mathworks.com/help/matlab/input-and-output-arguments.html) was introduced. Within an [arguments](https://mathworks.com/help/matlab/ref/arguments.html) block, the type, size, or other aspects of the inputs (and outputs since R2022b) can be verified.
|
|
237
|
+
In MATLAB R2019b the concept of [Argument Definitions](https://mathworks.com/help/matlab/input-and-output-arguments.html) was introduced. Within an [arguments](https://mathworks.com/help/matlab/ref/arguments.html) block, the type, size, or other aspects of the inputs (and outputs since R2022b) can be verified.
|
|
239
238
|
|
|
240
239
|
```matlab
|
|
241
240
|
function z = mySharedFunction(x,y,NameValueArgs)
|
|
242
241
|
arguments
|
|
243
242
|
x (1,1) double % scalar
|
|
244
|
-
y double {mustBeVector,mustBePositive}
|
|
243
|
+
y double {mustBeVector,mustBePositive}
|
|
245
244
|
NameValueArgs.A string
|
|
246
245
|
NameValueArgs.B string = "default"
|
|
247
|
-
end
|
|
246
|
+
end
|
|
248
247
|
...
|
|
249
248
|
end
|
|
250
249
|
```
|
|
251
250
|
|
|
252
251
|
The mkdocstrings-matlab plugin is able to parse the argument blocks and extract the type and default information, and any comment after each Argument Definition will be parsed as the argument docstring. If if `parse_arguments` is enabled, sections will be rendered for the parameters, name-value pairs and the return arguments of functions and methods. These sections can be individually toggled with [`show_docstring_input_arguments`][], [`show_docstring_name_value_arguments`][] and [`show_docstring_output_arguments`][].
|
|
253
252
|
|
|
254
|
-
|
|
255
253
|
=== "mkdocs.yml"
|
|
256
254
|
|
|
257
255
|
```yaml
|
|
@@ -306,7 +304,7 @@ The mkdocstrings-matlab plugin is able to parse the argument blocks and extract
|
|
|
306
304
|
|
|
307
305
|
!!! note
|
|
308
306
|
|
|
309
|
-
Prior to MATLAB R2019b, the functionality of the arguments blocks was most commonly achieved through [`inputParser`](https://mathworks.com/help/matlab/ref/inputparser.html). The validations created with `inputParser` will not be parsed by mkdocstrings-matlab, since it does not have a strict syntax as opposed to Argument Definitions.
|
|
307
|
+
Prior to MATLAB R2019b, the functionality of the arguments blocks was most commonly achieved through [`inputParser`](https://mathworks.com/help/matlab/ref/inputparser.html). The validations created with `inputParser` will not be parsed by mkdocstrings-matlab, since it does not have a strict syntax as opposed to Argument Definitions.
|
|
310
308
|
|
|
311
309
|
### Name-value arguments from class properties
|
|
312
310
|
|
|
@@ -349,7 +347,7 @@ The name-value argument is parsed with the struct name (`opts`) as the argument
|
|
|
349
347
|
|
|
350
348
|
Whether to merge the constructor method into the class' signature and docstring.
|
|
351
349
|
|
|
352
|
-
By default, only the class name is rendered in headings. When merging, the constructor method parameters are added after the class name, like a signature, and the constructor method docstring is appended to the class' docstring.
|
|
350
|
+
By default, only the class name is rendered in headings. When merging, the constructor method parameters are added after the class name, like a signature, and the constructor method docstring is appended to the class' docstring.
|
|
353
351
|
|
|
354
352
|
=== "mkdocs.yml"
|
|
355
353
|
|
|
@@ -405,14 +403,12 @@ By default, only the class name is rendered in headings. When merging, the const
|
|
|
405
403
|
merge_constructor_into_class: false
|
|
406
404
|
parse_arguments: true
|
|
407
405
|
```
|
|
408
|
-
|
|
406
|
+
|
|
409
407
|
::: Thing
|
|
410
408
|
options:
|
|
411
409
|
merge_constructor_into_class: false
|
|
412
410
|
parse_arguments: true
|
|
413
411
|
|
|
414
|
-
|
|
415
|
-
|
|
416
412
|
## `show_if_no_docstring`
|
|
417
413
|
|
|
418
414
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
|
|
@@ -471,7 +467,7 @@ With this option you can tell the Python handler to skip the docstring check.
|
|
|
471
467
|
options:
|
|
472
468
|
show_if_no_docstring: false
|
|
473
469
|
```
|
|
474
|
-
|
|
470
|
+
|
|
475
471
|
::: +undocumented
|
|
476
472
|
options:
|
|
477
473
|
show_if_no_docstring: false
|
|
@@ -689,7 +685,6 @@ Whether to render the "Classes" sections of docstrings.
|
|
|
689
685
|
show_docstring_classes: false
|
|
690
686
|
members: false
|
|
691
687
|
|
|
692
|
-
|
|
693
688
|
## `show_docstring_namespaces`
|
|
694
689
|
|
|
695
690
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
|
|
@@ -856,7 +851,7 @@ Whether to render the "Examples" sections of docstrings.
|
|
|
856
851
|
???+ preview
|
|
857
852
|
|
|
858
853
|
=== "With examples"
|
|
859
|
-
|
|
854
|
+
|
|
860
855
|
```markdown
|
|
861
856
|
::: print_hello
|
|
862
857
|
options:
|
|
@@ -884,7 +879,7 @@ Whether to render the "Examples" sections of docstrings.
|
|
|
884
879
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
|
|
885
880
|
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
|
|
886
881
|
|
|
887
|
-
Whether to render the "Parameters" sections of docstrings. The accepted title headings are `inputs` or `input arguments` (case-insensitive).
|
|
882
|
+
Whether to render the "Parameters" sections of docstrings. The accepted title headings are `inputs` or `input arguments` (case-insensitive).
|
|
888
883
|
|
|
889
884
|
=== "mkdocs.yml"
|
|
890
885
|
|
|
@@ -925,7 +920,7 @@ Whether to render the "Parameters" sections of docstrings. The accepted title he
|
|
|
925
920
|
options:
|
|
926
921
|
show_docstring_input_arguments: true
|
|
927
922
|
```
|
|
928
|
-
|
|
923
|
+
|
|
929
924
|
::: do_something
|
|
930
925
|
options:
|
|
931
926
|
show_docstring_input_arguments: true
|
|
@@ -951,7 +946,7 @@ Whether to render the "Parameters" sections of docstrings. The accepted title he
|
|
|
951
946
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
|
|
952
947
|
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
|
|
953
948
|
|
|
954
|
-
Whether to render the "Name-value pairs" sections of docstrings. The accepted title headings are `name-value pairs` or `name-value arguments` (case-insensitive).
|
|
949
|
+
Whether to render the "Name-value pairs" sections of docstrings. The accepted title headings are `name-value pairs` or `name-value arguments` (case-insensitive).
|
|
955
950
|
|
|
956
951
|
=== "mkdocs.yml"
|
|
957
952
|
|
|
@@ -992,7 +987,7 @@ Whether to render the "Name-value pairs" sections of docstrings. The accepted ti
|
|
|
992
987
|
options:
|
|
993
988
|
show_docstring_name_value_arguments: true
|
|
994
989
|
```
|
|
995
|
-
|
|
990
|
+
|
|
996
991
|
::: do_varargin
|
|
997
992
|
options:
|
|
998
993
|
show_docstring_name_value_arguments: true
|
|
@@ -1018,7 +1013,7 @@ Whether to render the "Name-value pairs" sections of docstrings. The accepted ti
|
|
|
1018
1013
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
|
|
1019
1014
|
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
|
|
1020
1015
|
|
|
1021
|
-
Whether to render the "Returns" sections of docstrings. The accepted title headings are `outputs` or `output arguments` (case-insensitive).
|
|
1016
|
+
Whether to render the "Returns" sections of docstrings. The accepted title headings are `outputs` or `output arguments` (case-insensitive).
|
|
1022
1017
|
|
|
1023
1018
|
=== "mkdocs.yml"
|
|
1024
1019
|
|
|
@@ -1059,7 +1054,7 @@ Whether to render the "Returns" sections of docstrings. The accepted title headi
|
|
|
1059
1054
|
options:
|
|
1060
1055
|
show_docstring_output_arguments: true
|
|
1061
1056
|
```
|
|
1062
|
-
|
|
1057
|
+
|
|
1063
1058
|
::: do_output
|
|
1064
1059
|
options:
|
|
1065
1060
|
show_docstring_output_arguments: true
|
|
@@ -43,7 +43,7 @@ Show the base classes of a class.
|
|
|
43
43
|
|
|
44
44
|
???+ preview
|
|
45
45
|
|
|
46
|
-
=== "with bases"
|
|
46
|
+
=== "with bases"
|
|
47
47
|
|
|
48
48
|
```markdown
|
|
49
49
|
::: myClass
|
|
@@ -56,7 +56,7 @@ Show the base classes of a class.
|
|
|
56
56
|
show_bases: true
|
|
57
57
|
|
|
58
58
|
=== "without bases"
|
|
59
|
-
|
|
59
|
+
|
|
60
60
|
```markdown
|
|
61
61
|
::: myClass
|
|
62
62
|
options:
|
|
@@ -69,13 +69,12 @@ Show the base classes of a class.
|
|
|
69
69
|
|
|
70
70
|
## `show_inheritance_diagram`
|
|
71
71
|
|
|
72
|
-
|
|
73
72
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
|
|
74
73
|
<!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
|
|
75
74
|
|
|
76
75
|
Show the inheritance diagram of a class using [Mermaid](https://mermaid.js.org/).
|
|
77
76
|
|
|
78
|
-
With this option enabled, an inheritance diagram (as a flowchart) will be displayed after a class
|
|
77
|
+
With this option enabled, an inheritance diagram (as a flowchart) will be displayed after a class signature. Each node will act as a cross-reference and will bring you to the relevant class' documentation when clicking on it.
|
|
79
78
|
|
|
80
79
|
It should work out of the box with [Material for MkDocs](https://squidfunk.github.io), but it is recommended to follow the [setup guide](https://squidfunk.github.io/mkdocs-material/reference/diagrams/#other-diagram-types) for optimal support in Material for Mkdocs. For other themes, you must either setup [mkdocs-mermaid2](https://mkdocs-mermaid2.readthedocs.io/en/latest), or include Mermaid's Javascript code manually:
|
|
81
80
|
|
|
@@ -166,8 +165,8 @@ Show the source code of this object.
|
|
|
166
165
|
|
|
167
166
|
???+ preview
|
|
168
167
|
|
|
169
|
-
=== "with source"
|
|
170
|
-
|
|
168
|
+
=== "with source"
|
|
169
|
+
|
|
171
170
|
```markdown
|
|
172
171
|
::: myfunction
|
|
173
172
|
options:
|
{mkdocstrings_matlab-2.1.1 → mkdocstrings_matlab-2.1.2}/docs/usage/configuration/headings.md
RENAMED
|
@@ -15,7 +15,7 @@ When injecting documentation for an object, the object itself and its members ar
|
|
|
15
15
|
|
|
16
16
|
The initial heading level will be used for the first layer. If you set it to 3, then headings will start with `<h3>`.
|
|
17
17
|
|
|
18
|
-
If the [heading for the root object]
|
|
18
|
+
If the [heading for the root object](#show_root_heading) is not shown, then the initial heading level is used for its members.
|
|
19
19
|
|
|
20
20
|
=== "mkdocs.yml"
|
|
21
21
|
|
|
@@ -43,7 +43,7 @@ If the [heading for the root object][show_root_heading] is not shown, then the i
|
|
|
43
43
|
|
|
44
44
|
--8<-- "docs/src/snippets/+mynamespace/mynamespace.md"
|
|
45
45
|
|
|
46
|
-
???+ preview
|
|
46
|
+
???+ preview
|
|
47
47
|
|
|
48
48
|
=== "With level 3 and root heading"
|
|
49
49
|
|
|
@@ -66,7 +66,6 @@ If the [heading for the root object][show_root_heading] is not shown, then the i
|
|
|
66
66
|
<h4><code>myfunction</code> (4)</h4>
|
|
67
67
|
<p>Docstring of the function.</p>
|
|
68
68
|
|
|
69
|
-
|
|
70
69
|
## `argument_headings`
|
|
71
70
|
|
|
72
71
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
|
|
@@ -178,7 +177,6 @@ The identifier used in the permalink and inventory is of the following form: `pa
|
|
|
178
177
|
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code> typed_function<br>
|
|
179
178
|
<code class="doc-symbol doc-symbol-toc doc-symbol-argument" style="margin-left: 16px;"></code> input
|
|
180
179
|
|
|
181
|
-
|
|
182
180
|
## `show_root_heading`
|
|
183
181
|
|
|
184
182
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
|
|
@@ -223,7 +221,7 @@ Sparing that extra level can be helpful when your objects tree is deeply nested
|
|
|
223
221
|
???+ preview
|
|
224
222
|
|
|
225
223
|
=== "With root heading"
|
|
226
|
-
|
|
224
|
+
|
|
227
225
|
::: mynamespace.classA
|
|
228
226
|
options:
|
|
229
227
|
show_root_heading: true
|
|
@@ -234,7 +232,7 @@ Sparing that extra level can be helpful when your objects tree is deeply nested
|
|
|
234
232
|
members: true
|
|
235
233
|
|
|
236
234
|
=== "Without root heading"
|
|
237
|
-
|
|
235
|
+
|
|
238
236
|
::: mynamespace.classA
|
|
239
237
|
options:
|
|
240
238
|
show_root_heading: false
|
|
@@ -250,7 +248,7 @@ Sparing that extra level can be helpful when your objects tree is deeply nested
|
|
|
250
248
|
|
|
251
249
|
If the root heading is not shown, at least add a ToC entry for it.
|
|
252
250
|
|
|
253
|
-
If you inject documentation for an object in the middle of a page, after long paragraphs, and without showing the [root heading]
|
|
251
|
+
If you inject documentation for an object in the middle of a page, after long paragraphs, and without showing the [root heading](#show_root_heading), then you will not be able to link to this particular object as it won't have a permalink and will be "lost" in the middle of text. In that case, it is useful to add a hidden anchor to the document, which will also appear in the table of contents.
|
|
254
252
|
|
|
255
253
|
In other cases, you might want to disable the entry to avoid polluting the ToC. It is not possible to show the root heading *and* hide the ToC entry.
|
|
256
254
|
|
|
@@ -296,10 +294,12 @@ More text.
|
|
|
296
294
|
show_root_toc_entry: true
|
|
297
295
|
```
|
|
298
296
|
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
[
|
|
302
|
-
[
|
|
297
|
+
<!-- rumdl-disable -->
|
|
298
|
+
**Table of contents**
|
|
299
|
+
[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" }
|
|
300
|
+
[`matlab_callable`](#permalink-to-object){ title="#permalink-to-object" }
|
|
301
|
+
[Other heading](#permalink-to-other-heading){ title="#permalink-to-other-heading" }
|
|
302
|
+
<!-- rumdl-enable -->
|
|
303
303
|
|
|
304
304
|
=== "Without ToC entry"
|
|
305
305
|
|
|
@@ -309,9 +309,11 @@ More text.
|
|
|
309
309
|
show_root_toc_entry: false
|
|
310
310
|
```
|
|
311
311
|
|
|
312
|
-
|
|
313
|
-
|
|
312
|
+
<!-- rumdl-disable -->
|
|
313
|
+
**Table of contents**
|
|
314
|
+
[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" }
|
|
314
315
|
[Other heading](#permalink-to-other-heading){ title="#permalink-to-other-heading" }
|
|
316
|
+
<!-- rumdl-enable -->
|
|
315
317
|
|
|
316
318
|
## `show_root_full_path`
|
|
317
319
|
|
|
@@ -383,7 +385,7 @@ With this option you can choose to show the full path of the object you inject d
|
|
|
383
385
|
|
|
384
386
|
Show the full namespace path of the root members.
|
|
385
387
|
|
|
386
|
-
This option does the same thing as [`show_root_full_path`][], but for direct members
|
|
388
|
+
This option does the same thing as [`show_root_full_path`][], but for direct members of the root object instead of the root object itself.
|
|
387
389
|
|
|
388
390
|
To show the full path for every member recursively, see [`show_object_full_path`][].
|
|
389
391
|
|
|
@@ -496,7 +498,7 @@ True | True | Full
|
|
|
496
498
|
show_docstring_output_arguments: false
|
|
497
499
|
|
|
498
500
|
=== "Without object full path"
|
|
499
|
-
|
|
501
|
+
|
|
500
502
|
```markdown
|
|
501
503
|
::: +mynamespace
|
|
502
504
|
options:
|
|
@@ -514,13 +516,13 @@ True | True | Full
|
|
|
514
516
|
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
|
|
515
517
|
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
|
|
516
518
|
|
|
517
|
-
When [grouped by categories]
|
|
519
|
+
When [grouped by categories](./members.md#group_by_category), show a heading for each category.
|
|
518
520
|
These category headings will appear in the table of contents,
|
|
519
521
|
allowing you to link to them using their permalinks.
|
|
520
522
|
|
|
521
523
|
!!! warning "Not recommended with deeply nested object"
|
|
522
524
|
|
|
523
|
-
When injecting documentation for deeply nested objects, you'll quickly run out of heading levels, and the objects at the bottom of the tree risk all getting documented using H6 headings, which might decrease the readability of your API docs.
|
|
525
|
+
When injecting documentation for deeply nested objects, you'll quickly run out of heading levels, and the objects at the bottom of the tree risk all getting documented using H6 headings, which might decrease the readability of your API docs.
|
|
524
526
|
|
|
525
527
|
=== "mkdocs.yml"
|
|
526
528
|
|
|
@@ -561,7 +563,7 @@ allowing you to link to them using their permalinks.
|
|
|
561
563
|
group_by_category: true
|
|
562
564
|
show_category_heading: true
|
|
563
565
|
```
|
|
564
|
-
|
|
566
|
+
|
|
565
567
|
::: +mynamespace
|
|
566
568
|
options:
|
|
567
569
|
group_by_category: true
|
|
@@ -642,7 +644,7 @@ See also [`show_symbol_type_toc`][show_symbol_type_toc].
|
|
|
642
644
|
|
|
643
645
|
::: docs/src/snippets
|
|
644
646
|
options:
|
|
645
|
-
members:
|
|
647
|
+
members:
|
|
646
648
|
- mynamespace
|
|
647
649
|
show_symbol_type_heading: true
|
|
648
650
|
show_docstring_input_arguments: false
|