hipnologo / ScribePy

ScribePy is a Python library that automates the process of generating documentation from source code for Python projects.

ScribePy

ScribePy is a Python library for generating documentation from Python source code.

Installation

You can install ScribePy using pip:

pip install ScribePy

Usage

To use ScribePy, you first need to create an instance of the ScribePy class:

from ScribePy.scribepy import ScribePy

source_code = '''
def add(x, y):
    """
    Add two numbers together.
    """
    return x + y
'''

p = ScribePy(source_code)

Once you have an instance of the ScribePy class, you can generate HTML documentation using the generate_html_docs method:

docs = p.generate_html_docs()
print(docs)

This will generate HTML documentation for the provided source code.

Documentation

For more information, see the official documentation or the GitHub repository.

Contributing

Contributions are welcome! To contribute to ScribePy, please follow these guidelines:

• Fork the repository.
• Create a new branch for your changes.
• Make your changes and write tests for them.
• Run the tests using pytest to make sure they pass.
• Submit a pull request.

For more information on how to contribute, please see the contributing guidelines in the GitHub repository.

Support

If you have any questions or need help using ScribePy, please post a question or open an issue on GitHub.