{"id":13316995,"url":"https://github.com/patrick-kidger/pytkdocs_tweaks","last_synced_at":"2025-11-17T15:34:06.366Z","repository":{"id":49749488,"uuid":"446836539","full_name":"patrick-kidger/pytkdocs_tweaks","owner":"patrick-kidger","description":"Some custom tweaks to the results produced by pytkdocs.","archived":false,"fork":false,"pushed_at":"2023-12-09T22:52:10.000Z","size":24,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-28T05:45:53.921Z","etag":null,"topics":["documentation","mkdocs","mkdocs-material","mkdocstrings","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patrick-kidger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["patrick-kidger"]}},"created_at":"2022-01-11T13:41:13.000Z","updated_at":"2023-06-09T09:37:40.000Z","dependencies_parsed_at":"2023-12-09T23:35:12.221Z","dependency_job_id":null,"html_url":"https://github.com/patrick-kidger/pytkdocs_tweaks","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"2a7ce453e315f526d792f689e61d56ecaa4ab000"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/patrick-kidger/pytkdocs_tweaks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick-kidger%2Fpytkdocs_tweaks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick-kidger%2Fpytkdocs_tweaks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick-kidger%2Fpytkdocs_tweaks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick-kidger%2Fpytkdocs_tweaks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrick-kidger","download_url":"https://codeload.github.com/patrick-kidger/pytkdocs_tweaks/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick-kidger%2Fpytkdocs_tweaks/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267527772,"owners_count":24102012,"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","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","mkdocs","mkdocs-material","mkdocstrings","python"],"created_at":"2024-07-29T18:23:43.919Z","updated_at":"2025-11-17T15:34:01.335Z","avatar_url":"https://github.com/patrick-kidger.png","language":"Python","funding_links":["https://github.com/sponsors/patrick-kidger"],"categories":[],"sub_categories":[],"readme":"# pytkdocs_tweaks\n\nSome custom tweaks for [pytkdocs](https://github.com/mkdocstrings/pytkdocs).\n\n_For use as part of the documentation-generation-for-Python stack that comprises [mkdocs](https://www.mkdocs.org/), [mkdocs-material](https://github.com/squidfunk/mkdocs-material), [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings/) and [pytkdocs](https://github.com/mkdocstrings/pytkdocs)._\n\n- Types are ubiquitously displayed in the way you import them: `package.Foo` (rather than being a mix of where they're defined: `package.subpackage.foomodule.Foo` or just their name: `Foo`).\n- Only public base classes are shown (rather than every base class).\n- Adds short documentation for inherited and implemented methods, e.g. \"Inherited from `package.Foo`.\" (Rather than nothing at all.)\n    - An inherited method is one inherited from a base class. An implemented method is one overriding an abstract method on a base class.\n- Sets a custom `typing.GENERATING_DOCUMENTATION = True` flag that you can use to detect when documentation generation is happening and customise things if desired (documentation generation imports the library you're documenting).\n- Adds an `abstractmethod`/`abstractproperty` property to appear in the documentation instead. (Useful when specifying abstract base classes.)\n- Removed the `dataclass` and `special` properties that appear in the documentation. (I find that these just add visual noise.)\n- Removed the `-\u003e None` return annotation on `__init__` methods.\n- Function-valued defaults now display as just `\u003cfunction foo\u003e` rather than `\u003cfunction foo at 0x7f5428d27a60\u003e`.\n\nNote that you must run the `mkdocs` command twice, as these custom tweaks write a cache to disk -- listing all the public objects -- that are then used on the second run. If you see a `.all_objects.cache` file appear -- this is why. (You may wish to add the file to your `.gitignore`.)\n\n## Installation\n\n```bash\npip install pytkdocs_tweaks\n```\n\nRequires Python 3.8+ and `pytkdocs==0.15.0`.\n\n## Usage\n\nIn your `mkdocs.yml`:\n\n```\nplugins:\n    - search  # default plugin, need to re-enable when using manual plugins\n    - mkdocstrings:\n        handlers:\n            python:\n                setup_commands:\n                    - import pytkdocs_tweaks\n                    - pytkdocs_tweaks.main()\n                selection:\n                    inherited_members: true  # allow looking up inherited members\n                rendering:\n                    show_root_heading: true    #\n                    show_root_full_path: true  # have e.g. `package.Foo` display correctly, rather than e.g. just `Foo`.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrick-kidger%2Fpytkdocs_tweaks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrick-kidger%2Fpytkdocs_tweaks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrick-kidger%2Fpytkdocs_tweaks/lists"}