Visualization of Mindmap represented in plantuml format using visjs network
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx_mindmap-0.5.2.tar.gz
.
File metadata
- Download URL: sphinx_mindmap-0.5.2.tar.gz
- Upload date:
- Size: 674.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.6 Darwin/22.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 934ff22cd0e26e378f54dcbc8aa121e5f449a5a6416c5466b801594e85376645 |
|
MD5 | 28c3c6174b836769501aefcea9153656 |
|
BLAKE2b-256 | 0d5ef444a9c134a62c77c137c2832e1d8504a6d5eab4d03c9d755a05f207b268 |
File details
Details for the file sphinx_mindmap-0.5.2-py3-none-any.whl
.
File metadata
- Download URL: sphinx_mindmap-0.5.2-py3-none-any.whl
- Upload date:
- Size: 681.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.6 Darwin/22.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ce7171a67746d1af3c5ad4f5b6fe42ad1245b93a59398a5a6e4c6a0e7c3c726 |
|
MD5 | 5b569a23e0475b17fc3409f3b28c4090 |
|
BLAKE2b-256 | ecb9f325c60fb51cb954b7006e46c0a5834a651e771bfaec3522b37343dd84a0 |