Skip to content

Transform Jupyter notebooks into comprehensive wikis, providing detailed descriptions for functions, classes, variables, and more.

License

Notifications You must be signed in to change notification settings

kabir12345/JupWiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JupWiki

JupWiki is a tool that transforms Jupyter notebooks into comprehensive wikis. It provides detailed descriptions for functions, classes, variables, and more, making your notebooks more understandable and accessible.

Installation

To install JupWiki, you need to have Python installed on your system. If you don't have Python installed, you can download it from here.

Once Python is installed, you can install JupWiki by cloning the repository and installing the requirements:

git clone https://github.com/kabir12345/JupWiki.git
cd JupWiki
pip install -r requirements.txt

Usage

To use JupWiki, run the main.py script with your Jupyter notebook as an argument:

python main.py your_notebook.ipynb

This will generate a wiki with detailed descriptions for all functions, classes, and variables in your notebook.

License

JupWiki is licensed under the Apache License 2.0.

About

Transform Jupyter notebooks into comprehensive wikis, providing detailed descriptions for functions, classes, variables, and more.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published