# 🧾 docu-lite [](https://pepy.tech/projects/docu-lite)
### ⚡ Ultra-light Zero-dependency HTML outline generator for Python.
- 📖 Browse classes and functions with collapsible docstrings in a tidy, readable format
- 📘 Specify your own stylesheet(s) or rely on the default (will be generated on run)
- 🎈 No dependencies, short script
- ⚙️ [Integrate into your GitHub Workflow](https://g1ojs.github.io/docu-lite/add-to-workflow/index.html) to have automatically up-to-date outline(s) in your repo
- 🛠️ Includes a text list of classes and functions useful for creating a delta view of API changes (e.g. using GitHub's compare)
- 👀 [Example live output:](https://g1ojs.github.io/docu-lite/docu-lite-outline.html)
- 👀 [Example live output (documentation mode):](https://g1ojs.github.io/docu-lite/docu-lite-outline-docmode.html)
## Screenshots
|User-facing | Browsable outline | Text file (e.g. for API delta) |
|--------------|-------------------|-------------------------|
|| ||
## 🛠 Installation
Install using pip: open a command window and type
```
pip install docu-lite
```
## 💡 Usage
Either edit and run docu-lite.py in an IDE, or run from the command line:
```
docu-lite # uses or creates docu-lite.ini
docu-lite --config alt.ini # uses alt.ini, errors if missing
```
Docu-lite will create a docu-lite.ini file if one doesn't exist.
⚙️ Edit the docu-lite.ini file to control how docu-lite runs:
- **pattern** specifies where to look for input
- **html** specifies the name of the output html file
- **css** specifies the name of the input style sheet, which will be referenced from the output html file
- **text_file** specifies the name of the text results file (text_file =) prevents text file creation
- **documentation_mode** produces a less detailed output styled for use as or editing into documentation.
- ignores code blocks starting with _ (e.g. def _name)
- hides 'self' in function argument lists
- provides inner content only for docstrings, not code
- style sheet dedicated to this mode can be specified in the ini file
- **ignore_docstrings_with** can be followed by = word to ignore docstrings containing the word (e.g. License, useful to stop license blocks appearing in the output)
📝 If the specified css file is not found, docu-lite will generate one and reference it in the html
## ⚠️ Known Issues
- Doesn't cleanly handle all variations of docstring layout. In particular, the single line docstring causes the body below the docstring to appear below it.
- Doesn't cleanly handle function definitions that span several lines (only first line is shown)
[PyPI link](https://pypi.org/project/docu-lite/)
Raw data
{
"_id": null,
"home_page": null,
"name": "docu-lite",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "documentation, docstring, python, html, code-outline, doc-generator, lightweight, static, cli, developer-tools",
"author": null,
"author_email": "G1OJS <g1ojs@yahoo.com>",
"download_url": "https://files.pythonhosted.org/packages/20/14/6f410af76cd2d3fe1bc5ebbb98bab2b5c43c65d5e484fae8d52f63a72acd/docu_lite-1.5.1.tar.gz",
"platform": null,
"description": "# \ud83e\uddfe docu-lite [](https://pepy.tech/projects/docu-lite)\r\n\r\n### \u26a1 Ultra-light Zero-dependency HTML outline generator for Python. \r\n\r\n\r\n\r\n- \ud83d\udcd6 Browse classes and functions with collapsible docstrings in a tidy, readable format \r\n- \ud83d\udcd8 Specify your own stylesheet(s) or rely on the default (will be generated on run) \r\n- \ud83c\udf88 No dependencies, short script\r\n- \u2699\ufe0f [Integrate into your GitHub Workflow](https://g1ojs.github.io/docu-lite/add-to-workflow/index.html) to have automatically up-to-date outline(s) in your repo\r\n- \ud83d\udee0\ufe0f Includes a text list of classes and functions useful for creating a delta view of API changes (e.g. using GitHub's compare)\r\n- \ud83d\udc40 [Example live output:](https://g1ojs.github.io/docu-lite/docu-lite-outline.html)\r\n- \ud83d\udc40 [Example live output (documentation mode):](https://g1ojs.github.io/docu-lite/docu-lite-outline-docmode.html)\r\n \r\n## Screenshots\r\n\r\n|User-facing | Browsable outline | Text file (e.g. for API delta) |\r\n|--------------|-------------------|-------------------------|\r\n|| ||\r\n\r\n## \ud83d\udee0 Installation\r\n\r\nInstall using pip: open a command window and type\r\n\r\n```\r\npip install docu-lite\r\n```\r\n## \ud83d\udca1 Usage\r\nEither edit and run docu-lite.py in an IDE, or run from the command line:\r\n```\r\ndocu-lite # uses or creates docu-lite.ini\r\ndocu-lite --config alt.ini # uses alt.ini, errors if missing\r\n```\r\nDocu-lite will create a docu-lite.ini file if one doesn't exist.\r\n\r\n\u2699\ufe0f Edit the docu-lite.ini file to control how docu-lite runs:\r\n - **pattern** specifies where to look for input\r\n - **html** specifies the name of the output html file\r\n - **css** specifies the name of the input style sheet, which will be referenced from the output html file\r\n - **text_file** specifies the name of the text results file (text_file =) prevents text file creation\r\n - **documentation_mode** produces a less detailed output styled for use as or editing into documentation. \r\n - ignores code blocks starting with _ (e.g. def _name)\r\n - hides 'self' in function argument lists\r\n - provides inner content only for docstrings, not code\r\n - style sheet dedicated to this mode can be specified in the ini file\r\n - **ignore_docstrings_with** can be followed by = word to ignore docstrings containing the word (e.g. License, useful to stop license blocks appearing in the output) \r\n\r\n\r\n\ud83d\udcdd If the specified css file is not found, docu-lite will generate one and reference it in the html\r\n\r\n## \u26a0\ufe0f Known Issues\r\n - Doesn't cleanly handle all variations of docstring layout. In particular, the single line docstring causes the body below the docstring to appear below it.\r\n - Doesn't cleanly handle function definitions that span several lines (only first line is shown)\r\n\r\n[PyPI link](https://pypi.org/project/docu-lite/)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "\ud83e\uddfe docu-lite: Ultra-light Zero-dependency HTML outline generator for Python.",
"version": "1.5.1",
"project_urls": {
"Homepage": "https://github.com/G1OJS/docu-lite",
"Issues": "https://github.com/G1OJS/docu-lite/issues"
},
"split_keywords": [
"documentation",
" docstring",
" python",
" html",
" code-outline",
" doc-generator",
" lightweight",
" static",
" cli",
" developer-tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1982bf64b4dd965da28636c140a35f9b658e161503da76922ef3e73e1bb616b2",
"md5": "50b5f75cafb2b81e84630434338e0bce",
"sha256": "180643d9b4d539f0505c8d48b4ba1c36d12a3c38c50da1a6bb7f0f59e3894fa6"
},
"downloads": -1,
"filename": "docu_lite-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "50b5f75cafb2b81e84630434338e0bce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8091,
"upload_time": "2025-07-27T18:41:40",
"upload_time_iso_8601": "2025-07-27T18:41:40.397695Z",
"url": "https://files.pythonhosted.org/packages/19/82/bf64b4dd965da28636c140a35f9b658e161503da76922ef3e73e1bb616b2/docu_lite-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "20146f410af76cd2d3fe1bc5ebbb98bab2b5c43c65d5e484fae8d52f63a72acd",
"md5": "82b9469f3ce7fb477d411b3a5e852792",
"sha256": "a846ae30513a470667abc5762beaefbbfd9f479a149f0f3c0823c3ba31905efd"
},
"downloads": -1,
"filename": "docu_lite-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "82b9469f3ce7fb477d411b3a5e852792",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7805,
"upload_time": "2025-07-27T18:41:41",
"upload_time_iso_8601": "2025-07-27T18:41:41.581974Z",
"url": "https://files.pythonhosted.org/packages/20/14/6f410af76cd2d3fe1bc5ebbb98bab2b5c43c65d5e484fae8d52f63a72acd/docu_lite-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-27 18:41:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "G1OJS",
"github_project": "docu-lite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "docu-lite"
}
JSON
