Metadata-Version: 2.1
Name: handsdown
Version: 0.1.1
Summary: # 🙌 Handsdown - Python documentation generator
Home-page: https://github.com/vemel/handsdown
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: UNKNOWN
Description: # 🙌 Handsdown - Python documentation generator
        
        Python docstring-based documentation generator for lazy people.
        
        ## 🔬 Features
        
        - 👓 PEP257, Google and RST docstrings support. All of them are converted to a valid markdown.
        - 🐈 Github-friendly. Use your local markdown viewer or open docs [right on Github](docs/index.md)
        - 📚 Signatures for every class, function and method.
        - 🚀 Support for type annotations. Even for the ones from the `__future__`!
        - 📦 Nice list of all modules in [Modules](docs/index.md#modules)
        - 🔎 Gather all scattered `README.md` in submodules to one place
        - 🚧 Links to source code from every doc section.
        - #️⃣ Create cross-references easily `handsdown.handsdown.Handsdown.replace_links` (check [index.md](docs/index.md#features))
        - 💕 Do you love type annotations? Well, you get auto-discovery of related modules for free!
        
        ## 🎉 Usage
        
        ### 💻 From command line
        
        Just go to your favorite project that has lots of docstrings but missing auto-generated docs and let `handsdown` do the thing.
        
        ```bash
        cd ~/my/project
        handsdown -o docs
        ```
        
        Navigate to `docs/index.md` to check your new documentation!
        
        ### 🧩 As a module
        
        ```python
        from handsdown.handsdown import Handsdown
        handsdown = Handsdown(
            input_path=Path('path/to/my/repo'),
            output_path=Path('path/to/output'),
        )
        
        # generate all docs at once
        handsdown.generate()
        
        # or generate one doc
        output_file_path = handsdown.generate_doc(Path('path/to/my/repo/source.py'))
        output_file_path # Path('path/to/output/source.md')
        ```
        
        ## 🔧 Installation
        
        Install using pip
        
        ```bash
        pip install handsdown
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
