Sphinx Tree View
A lightweight Sphinx extension that provides a customizable, filesystem-like tree view for your documentation.
Installation
Install the extension via PyPI:
pip install sphinx-treeview
Then, add it to the extensions list in your conf.py:
extensions = ["sphinx_treeview"]
If you are using MyST Parser to write Markdown documentation, it’s recommended to enable the colon_fence syntax extension:
extensions = ["myst_parser", "sphinx_treeview"]
myst_enable_extensions = ["colon_fence"]
Example
:::{treeview}
- {dir}`folder` folder
- {dir}`file` file.jpeg
- {dir}`file` file.png
:::
License
This project is licensed under the MPL-2.0 License. See the LICENSE file for details. Images came from pictogrammers and are under Apache-2.0 License.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-treeview 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_treeview-1.1.1.tar.gz | 12.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_treeview-1.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 26.8 kB
Release files / sphinx_treeview-1.1.1.tar.gz
| Download URL | sphinx_treeview-1.1.1.tar.gz |
|---|---|
| Size | 12.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0d93c1265cc58190714a2800cdd72580f370a8b580479dca7a5883a222fa3a6f
|
|
BLAKE2b-256 checksum How to use checksums |
3145701be0ec3e658f59a25058ffaf585adc1c3a761dd3e5c47fad38cba6ec21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
pdm/2.25.3 CPython/3.13.3 Linux/6.11.0-1015-azure
|
Release files / sphinx_treeview-1.1.1-py3-none-any.whl
| Download URL | sphinx_treeview-1.1.1-py3-none-any.whl |
|---|---|
| Size | 14.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
281a3b25185bc52e38a5c37dd83732466b34967b994a0c5c034ceeeb4b2f7136
|
|
BLAKE2b-256 checksum How to use checksums |
5c58d16abc76821b7fa1a4e45f7574d6420b13e06249976b5a3d95e29c3af258
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
pdm/2.25.3 CPython/3.13.3 Linux/6.11.0-1015-azure
|
