{"id":23395949,"url":"https://github.com/matthewdeanmartin/pydoc_fork","last_synced_at":"2025-04-11T14:13:23.435Z","repository":{"id":62579959,"uuid":"428001350","full_name":"matthewdeanmartin/pydoc_fork","owner":"matthewdeanmartin","description":"Run pydoc on a build server to generate API docs","archived":false,"fork":false,"pushed_at":"2024-12-23T19:47:20.000Z","size":4490,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T10:21:34.321Z","etag":null,"topics":["docstrings","pydoc","python"],"latest_commit_sha":null,"homepage":"https://matthewdeanmartin.github.io/pydoc_fork/docs_pydoc_fork/pydoc_fork.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matthewdeanmartin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-14T17:58:16.000Z","updated_at":"2024-12-23T19:47:24.000Z","dependencies_parsed_at":"2023-02-08T04:30:42.504Z","dependency_job_id":null,"html_url":"https://github.com/matthewdeanmartin/pydoc_fork","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewdeanmartin%2Fpydoc_fork","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewdeanmartin%2Fpydoc_fork/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewdeanmartin%2Fpydoc_fork/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthewdeanmartin%2Fpydoc_fork/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matthewdeanmartin","download_url":"https://codeload.github.com/matthewdeanmartin/pydoc_fork/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248415039,"owners_count":21099593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docstrings","pydoc","python"],"created_at":"2024-12-22T07:19:45.241Z","updated_at":"2025-04-11T14:13:23.413Z","avatar_url":"https://github.com/matthewdeanmartin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewdeanmartin%2Fpydoc_fork","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatthewdeanmartin%2Fpydoc_fork","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthewdeanmartin%2Fpydoc_fork/lists"}