Metadata-Version: 2.1
Name: pydoc_fork
Version: 3.3.0
Summary: Fork of cpython's pydoc module to do just html document generation
Home-page: https://github.com/matthewdeanmartin/pydoc_fork
License: MIT
Keywords: pydoc,html documentation
Author: Matthew Martin
Author-email: matthewdeanmartin@gmail.com
Requires-Python: >=3.8,<4
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: docopt-ng (>=0.9.0,<1)
Requires-Dist: docutils (>=0.20.1,<1)
Requires-Dist: jinja2 (>=3.1.3,<4)
Requires-Dist: markdown (>=3.5.2,<4)
Requires-Dist: tomli (>=2.0.1,<3)
Requires-Dist: typing_extensions
Project-URL: Bug Tracker, https://github.com/matthewdeanmartin/pydoc_fork/issues
Project-URL: Change Log, https://github.com/matthewdeanmartin/pydoc_fork/blob/main/CHANGES.md
Project-URL: Documentation, https://github.com/matthewdeanmartin/pydoc_fork
Project-URL: Repository, https://github.com/matthewdeanmartin/pydoc_fork
Description-Content-Type: text/markdown

# pydoc_fork

A fork of pydoc to optimize it for generating, on a build server, html documentation for a python library you wrote

Less ambitious than the very good [pdoc3](https://pdoc3.github.io/pdoc/) and easier to use
than [Sphinx](https://www.sphinx-doc.org/en/master/)

## Installation

Requires Python 3.8+

```bash
pip install pydoc_fork

# or virtual environment access
pipenv install pydoc_fork

# WARNING- installation by pipx will only allow for doc generation of the python standard library!
pipx install pydoc_fork
```

## Usage

```bash
# Generate HTML for all modules and submodules from source code
pydoc_fork my_module --output docs --document_internals

# Generate HTML for a module that is importable, e.g. sys
pydoc_fork sys --output docs
```

## Docs

- [Motivation](https://github.com/matthewdeanmartin/pydoc_fork/blob/main/docs/motivation.md)
- [Prior Art](https://github.com/matthewdeanmartin/pydoc_fork/blob/main/docs/prior_art.md)
- [TODO](https://github.com/matthewdeanmartin/pydoc_fork/blob/main/docs/TODO.md)

## pydoc_fork documented in several ways:

- [pydoc_fork](https://matthewdeanmartin.github.io/pydoc_fork/docs_pydoc_fork/pydoc_fork.html)
- [Pycco](https://matthewdeanmartin.github.io/pydoc_fork/docs_pycco/index.html)
- [PyDoctor](https://matthewdeanmartin.github.io/pydoc_fork/docs_pydoctor/index.html)
- [pdoc3](https://matthewdeanmartin.github.io/pydoc_fork/docs_pdoc3/pydoc_fork/index.html)
- [mkdocstrings](https://matthewdeanmartin.github.io/pydoc_fork/docs_mkdocstrings/index.html)
- [sphinx](https://matthewdeanmartin.github.io/pydoc_fork/docs_sphinx/py-modindex.html)

## Credits

Forked from [pydoc in python 3.10](https://github.com/python/cpython/blob/3.10/Lib/pydoc.py).

That code is governed by the cpython [license](https://github.com/python/cpython/blob/main/LICENSE)

I picked a MIT license, but I'm no lawyer, the cpython license probably governs in any conflict.

