Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matthewdeanmartin/pydoc_fork
Run pydoc on a build server to generate API docs
https://github.com/matthewdeanmartin/pydoc_fork
docstrings pydoc python
Last synced: 19 days ago
JSON representation
Run pydoc on a build server to generate API docs
- Host: GitHub
- URL: https://github.com/matthewdeanmartin/pydoc_fork
- Owner: matthewdeanmartin
- License: mit
- Created: 2021-11-14T17:58:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-26T03:09:51.000Z (8 months ago)
- Last Synced: 2024-12-01T02:12:53.095Z (about 1 month ago)
- Topics: docstrings, pydoc, python
- Language: Python
- Homepage: https://matthewdeanmartin.github.io/pydoc_fork/docs_pydoc_fork/pydoc_fork.html
- Size: 4.25 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.