pydoc2markdown 0.1.0__tar.gz

pydoc2markdown-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: |
+          ruff check src tests
+          ruff format --check src tests
+
+      - name: Type check with mypy
+        run: mypy src
+
+      - name: Run tests
+        run: pytest --cov-report=xml
+
+      - name: Upload coverage
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false
+
+  release:
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*

pydoc2markdown-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: python
+          package-name: pydoc2markdown
+
+  publish:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pydoc2markdown/${{ needs.release-please.outputs.tag_name }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pydoc2markdown-0.1.0/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db

pydoc2markdown-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.14
+    hooks:
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          ["docstring-parser>=0.15", "Jinja2>=3.1.0"]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files

pydoc2markdown-0.1.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 0.1.0 (2026-05-26)
+
+
+### Features
+
+* add --theme support with default and minimal built-in themes ([d4db85a](https://github.com/f1sherFM/PyDoc2Markdown/commit/d4db85a110bb60e6c73c80c37525af8b106a6e63))
+* add --watch mode, pyproject.toml config, release-please CI workflow ([29cb01c](https://github.com/f1sherFM/PyDoc2Markdown/commit/29cb01c96cae5f9cdbdfd635bdba505d06397844))
+* add property, classmethod, staticmethod, dataclass, enum, typeddict, __all__ parsing ([8f3b548](https://github.com/f1sherFM/PyDoc2Markdown/commit/8f3b54865e118ab8b00817d18cbf8f3a359b8f6c))
+* add TOC and auto-generated index.md ([9616e8a](https://github.com/f1sherFM/PyDoc2Markdown/commit/9616e8a3cdfafd37e1789bba409f3ea1720e972d))
+* group output by package and create nested directories ([fe7d629](https://github.com/f1sherFM/PyDoc2Markdown/commit/fe7d6293e537163a7c2305c24a8044f1396badef))
+* initial project structure for PyDoc2Markdown ([07a480d](https://github.com/f1sherFM/PyDoc2Markdown/commit/07a480d72f95cea98151c736b50b6867e9627706))
+* initial release on PyPI ([fc612f5](https://github.com/f1sherFM/PyDoc2Markdown/commit/fc612f52185ed53dd84f49aaa0969b4c61152b15))
+* integrate docstring-parser, add verbose logging, setup pre-commit hooks ([acd4ab6](https://github.com/f1sherFM/PyDoc2Markdown/commit/acd4ab61c2de458095e58f8ffbc2b9dfd41f1241))
+
+
+### Bug Fixes
+
+* Python 3.10 compat for tomllib, downgrade release-please to v3 ([e9f5cce](https://github.com/f1sherFM/PyDoc2Markdown/commit/e9f5cce27a70d1c7994b2991b220b8c424c0024b))
+
+
+### Documentation
+
+* update CONTRIBUTING.md with release-please and versioning info ([a82ba61](https://github.com/f1sherFM/PyDoc2Markdown/commit/a82ba61fe55a249139dd40875195fcfcafc6e374))
+* update README with new features and usage examples ([ca47680](https://github.com/f1sherFM/PyDoc2Markdown/commit/ca476807eeddf3f36442f02373f67eb83a9823df))

pydoc2markdown-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to PyDoc2Markdown
+
+Thank you for your interest in contributing! This document provides guidelines to help you get started.
+
+## Development Setup
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/f1sherFM/PyDoc2Markdown.git
+   cd PyDoc2Markdown
+   ```
+
+2. **Create a virtual environment**
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # Linux/macOS
+   .venv\Scripts\activate      # Windows
+   ```
+
+3. **Install in development mode**
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+## Conventional Commits
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification. Prefix your commit messages:
+
+- `feat:` — New features (triggers **MINOR** version bump)
+- `fix:` — Bug fixes (triggers **PATCH** version bump)
+- `docs:` — Documentation changes
+- `style:` — Code style changes (formatting, semicolons, etc.)
+- `refactor:` — Code refactoring
+- `test:` — Adding or updating tests
+- `chore:` — Build process or auxiliary tool changes
+
+Example:
+```bash
+git commit -m "feat: add support for NumPy-style docstrings"
+```
+
+## Automated Releases
+
+This project uses [release-please](https://github.com/googleapis/release-please) to automate versioning and publishing:
+
+1. When a PR with conventional commits is merged to `main`, release-please analyzes the commit history.
+2. If there are releasable changes, release-please opens a **Release PR** containing:
+   - Bumped version in `pyproject.toml`
+   - Updated `CHANGELOG.md`
+3. Merging the Release PR creates a **GitHub Release** and triggers a PyPI publish via Trusted Publishing.
+
+**Version bumping rules:**
+- `feat:` commits bump the **minor** version (e.g. `0.1.0` → `0.2.0`)
+- `fix:` commits bump the **patch** version (e.g. `0.1.0` → `0.1.1`)
+- A commit footer with `BREAKING CHANGE:` bumps the **major** version
+
+Commits with prefixes `docs:`, `style:`, `refactor:`, `test:`, `chore:` do not trigger a release by themselves.
+
+## Code Quality
+
+Before submitting a PR, ensure all checks pass:
+
+```bash
+ruff check src tests
+ruff format --check src tests
+mypy src
+pytest
+```
+
+## Pull Request Process
+
+1. Fork the repository and create a feature branch.
+2. Make your changes with clear, focused commits.
+3. Add or update tests for any new functionality.
+4. Update documentation if needed.
+5. Open a PR with a descriptive title and summary.
+
+## Questions?
+
+Open an [issue](https://github.com/f1sherFM/PyDoc2Markdown/issues) or start a [discussion](https://github.com/f1sherFM/PyDoc2Markdown/discussions).

pydoc2markdown-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 f1sherFM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pydoc2markdown-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: pydoc2markdown
+Version: 0.1.0
+Summary: Convert Python docstrings to Markdown documentation.
+Project-URL: Homepage, https://github.com/f1sherFM/PyDoc2Markdown
+Project-URL: Repository, https://github.com/f1sherFM/PyDoc2Markdown
+Project-URL: Issues, https://github.com/f1sherFM/PyDoc2Markdown/issues
+Author-email: f1sherFM <f1sherFM@example.com>
+License: MIT
+License-File: LICENSE
+Keywords: docstring,documentation,markdown,python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: docstring-parser>=0.15
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: tomli>=1.2.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.5.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.5.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: watchdog>=3.0; extra == 'dev'
+Provides-Extra: watch
+Requires-Dist: watchdog>=3.0; extra == 'watch'
+Description-Content-Type: text/markdown
+
+# PyDoc2Markdown
+
+[![CI](https://github.com/f1sherFM/PyDoc2Markdown/actions/workflows/ci.yml/badge.svg)](https://github.com/f1sherFM/PyDoc2Markdown/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/f1sherFM/PyDoc2Markdown/branch/main/graph/badge.svg)](https://codecov.io/gh/f1sherFM/PyDoc2Markdown)
+[![PyPI](https://img.shields.io/pypi/v/pydoc2markdown)](https://pypi.org/project/pydoc2markdown/)
+
+> Convert Python docstrings into clean, structured Markdown documentation.
+
+## Features
+
+- **Docstring parsing** — Extract Google, NumPy, and reStructuredText style docstrings with structured params, returns, and raises.
+- **Markdown generation** — Produce beautiful Markdown files with customizable Jinja2 templates.
+- **Auto-generated index & TOC** — Each module gets a Table of Contents; an `index.md` with package grouping is created automatically.
+- **Package grouping** — Output files are organized into subdirectories matching the package structure.
+- **Built-in themes** — Choose between `default` (detailed) and `minimal` themes, or supply your own template.
+- **CLI & API** — Use via command line or import as a Python library.
+- **Recursive processing** — Scan entire packages in one command.
+- **Type-aware** — Respects type hints and annotations.
+- **Advanced constructs** — Supports `property`, `classmethod`, `staticmethod`, `dataclass`, `Enum`, `TypedDict`, and `__all__`.
+
+## Installation
+
+```bash
+pip install pydoc2markdown
+```
+
+## Quick Start
+
+### CLI Usage
+
+```bash
+# Generate docs for a single file
+pydoc2markdown my_module.py -o docs
+
+# Recursively process a package
+pydoc2markdown src/my_package --recursive -o docs
+
+# Use a built-in theme
+pydoc2markdown src/my_package --recursive --theme minimal -o docs
+
+# Use a custom template
+pydoc2markdown src/my_package --recursive --template custom.md.j2 -o docs
+
+# Enable verbose logging
+pydoc2markdown src/my_package --recursive -vv -o docs
+```
+
+### Library Usage
+
+```python
+from pathlib import Path
+from pydoc2markdown import DocstringParser, MarkdownGenerator
+
+parser = DocstringParser()
+modules = parser.parse(Path("src/my_package"), recursive=True)
+
+generator = MarkdownGenerator(theme="default")
+generator.generate(modules, output_dir=Path("docs"))
+```
+
+## Documentation
+
+- [Contributing Guide](CONTRIBUTING.md)
+- [Project Structure](PROJECT_STRUCTURE.md)
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.