# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/matthewdeanmartin/pydoc_fork",
"name": "pydoc-fork",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "pydoc,html documentation",
"author": "Matthew Martin",
"author_email": "matthewdeanmartin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/af/80/d3e988bdb729df73ad388ce0bf21e82c13adf0d84c8e58b7729748c2cab8/pydoc_fork-3.3.0.tar.gz",
"platform": null,
"description": "# pydoc_fork\n\nA fork of pydoc to optimize it for generating, on a build server, html documentation for a python library you wrote\n\nLess ambitious than the very good [pdoc3](https://pdoc3.github.io/pdoc/) and easier to use\nthan [Sphinx](https://www.sphinx-doc.org/en/master/)\n\n## Installation\n\nRequires Python 3.8+\n\n```bash\npip install pydoc_fork\n\n# or virtual environment access\npipenv install pydoc_fork\n\n# WARNING- installation by pipx will only allow for doc generation of the python standard library!\npipx install pydoc_fork\n```\n\n## Usage\n\n```bash\n# Generate HTML for all modules and submodules from source code\npydoc_fork my_module --output docs --document_internals\n\n# Generate HTML for a module that is importable, e.g. sys\npydoc_fork sys --output docs\n```\n\n## Docs\n\n- [Motivation](https://github.com/matthewdeanmartin/pydoc_fork/blob/main/docs/motivation.md)\n- [Prior Art](https://github.com/matthewdeanmartin/pydoc_fork/blob/main/docs/prior_art.md)\n- [TODO](https://github.com/matthewdeanmartin/pydoc_fork/blob/main/docs/TODO.md)\n\n## pydoc_fork documented in several ways:\n\n- [pydoc_fork](https://matthewdeanmartin.github.io/pydoc_fork/docs_pydoc_fork/pydoc_fork.html)\n- [Pycco](https://matthewdeanmartin.github.io/pydoc_fork/docs_pycco/index.html)\n- [PyDoctor](https://matthewdeanmartin.github.io/pydoc_fork/docs_pydoctor/index.html)\n- [pdoc3](https://matthewdeanmartin.github.io/pydoc_fork/docs_pdoc3/pydoc_fork/index.html)\n- [mkdocstrings](https://matthewdeanmartin.github.io/pydoc_fork/docs_mkdocstrings/index.html)\n- [sphinx](https://matthewdeanmartin.github.io/pydoc_fork/docs_sphinx/py-modindex.html)\n\n## Credits\n\nForked from [pydoc in python 3.10](https://github.com/python/cpython/blob/3.10/Lib/pydoc.py).\n\nThat code is governed by the cpython [license](https://github.com/python/cpython/blob/main/LICENSE)\n\nI picked a MIT license, but I'm no lawyer, the cpython license probably governs in any conflict.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fork of cpython's pydoc module to do just html document generation",
"version": "3.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/matthewdeanmartin/pydoc_fork/issues",
"Change Log": "https://github.com/matthewdeanmartin/pydoc_fork/blob/main/CHANGES.md",
"Documentation": "https://github.com/matthewdeanmartin/pydoc_fork",
"Homepage": "https://github.com/matthewdeanmartin/pydoc_fork",
"Repository": "https://github.com/matthewdeanmartin/pydoc_fork"
},
"split_keywords": [
"pydoc",
"html documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57d4a0f742c96437675d9442cf711aae1c858b4f106115541fc8884b74692118",
"md5": "2fd8c1eb62dfcb03bd3cf40a37ee3771",
"sha256": "7f4cbd6cf81648f296b257a768ad28ef550487c2adcf9b85a8a0d7eba6c8f005"
},
"downloads": -1,
"filename": "pydoc_fork-3.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fd8c1eb62dfcb03bd3cf40a37ee3771",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 34931,
"upload_time": "2024-02-18T23:10:16",
"upload_time_iso_8601": "2024-02-18T23:10:16.544524Z",
"url": "https://files.pythonhosted.org/packages/57/d4/a0f742c96437675d9442cf711aae1c858b4f106115541fc8884b74692118/pydoc_fork-3.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af80d3e988bdb729df73ad388ce0bf21e82c13adf0d84c8e58b7729748c2cab8",
"md5": "2b311421c990c963986154b2675fd7dd",
"sha256": "ac35a98faad5731263dbdcc0cc8fbe3cd085bc7d71df54eb19c1fbda835aab0f"
},
"downloads": -1,
"filename": "pydoc_fork-3.3.0.tar.gz",
"has_sig": false,
"md5_digest": "2b311421c990c963986154b2675fd7dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 26608,
"upload_time": "2024-02-18T23:10:18",
"upload_time_iso_8601": "2024-02-18T23:10:18.479053Z",
"url": "https://files.pythonhosted.org/packages/af/80/d3e988bdb729df73ad388ce0bf21e82c13adf0d84c8e58b7729748c2cab8/pydoc_fork-3.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-18 23:10:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "matthewdeanmartin",
"github_project": "pydoc_fork",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pydoc-fork"
}
JSON
