sphinx_mindmap
About
The sphinx_mindmap is a web application written in HTML, CSS, and JavaScript, provided as a Sphinx extension. It renders plantuml mindmap using visjs network. It was tested only with sphinx_book_theme
Goals and Realization
- Packaging and dependency management: poetry
- Development: vscode devcontainer
- CI/CT using github actions
- package generation
- documentation generation and deployment to github pages
Installation
TBD
You can install sphinx_mindmap with pip
pip install sphinx_mindmap
Alternatively (Linux)
git clone https://github.com/mi-parkes/sphinx_mindmap.git
cd sphinx_mindmap
poetry install
poetry build
# you can then install the package in your virtual environment
pip install dist/sphinx_mindmap*.whl
Activation
In your conf.py configuration file, add sphinx_mindmap to your extensions list:
extensions = [
...
'sphinx_mindmap'
...
]
...
You can embedd a HTML frame with plantuml mindmap rendering by using the following directive in your .rst file(s)
.. mindmap:: ../../_static/puml/sphinx_needs_data_explorer.puml
Current limitation: mindmaps can be stored only in _static directory or its subdirectories
Metadata
Release files for sphinx_mindmap 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_mindmap-0.5.2.tar.gz | 674.9 kB | Without provenance | Details for sphinx_mindmap-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_mindmap-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for sphinx_mindmap-0.5.2-py3-none-any.whl |
Total release size: 1.4 MB
Release files / sphinx_mindmap-0.5.2.tar.gz
| Download URL | sphinx_mindmap-0.5.2.tar.gz |
|---|---|
| Size | 674.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
934ff22cd0e26e378f54dcbc8aa121e5f449a5a6416c5466b801594e85376645
|
|
BLAKE2b-256 checksum How to use checksums |
0d5ef444a9c134a62c77c137c2832e1d8504a6d5eab4d03c9d755a05f207b268
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.6 Darwin/22.6.0
|
Release files / sphinx_mindmap-0.5.2-py3-none-any.whl
| Download URL | sphinx_mindmap-0.5.2-py3-none-any.whl |
|---|---|
| Size | 681.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6ce7171a67746d1af3c5ad4f5b6fe42ad1245b93a59398a5a6e4c6a0e7c3c726
|
|
BLAKE2b-256 checksum How to use checksums |
ecb9f325c60fb51cb954b7006e46c0a5834a651e771bfaec3522b37343dd84a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.6 Darwin/22.6.0
|
Security for sphinx_mindmap 0.5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.