{"id":15057029,"url":"https://github.com/ai2business/mkdocstrings-sourcelink","last_synced_at":"2025-10-05T00:30:38.098Z","repository":{"id":45438414,"uuid":"333207345","full_name":"AI2Business/mkdocstrings-sourcelink","owner":"AI2Business","description":"Automatic source link generation for mkdocstrings","archived":true,"fork":false,"pushed_at":"2023-04-03T23:06:18.000Z","size":1523,"stargazers_count":4,"open_issues_count":5,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-18T01:19:02.092Z","etag":null,"topics":["autodoc","docstrings","documentation-generator","markdown","mkdocs","mkdocstrings","python","utilities"],"latest_commit_sha":null,"homepage":"https://ai2business.github.io/mkdocstrings-sourcelink/","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/AI2Business.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-26T20:23:26.000Z","updated_at":"2023-04-22T09:20:15.000Z","dependencies_parsed_at":"2023-02-16T12:01:17.693Z","dependency_job_id":null,"html_url":"https://github.com/AI2Business/mkdocstrings-sourcelink","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AI2Business%2Fmkdocstrings-sourcelink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AI2Business%2Fmkdocstrings-sourcelink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AI2Business%2Fmkdocstrings-sourcelink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AI2Business%2Fmkdocstrings-sourcelink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AI2Business","download_url":"https://codeload.github.com/AI2Business/mkdocstrings-sourcelink/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235330435,"owners_count":18972830,"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":["autodoc","docstrings","documentation-generator","markdown","mkdocs","mkdocstrings","python","utilities"],"created_at":"2024-09-24T22:01:08.505Z","updated_at":"2025-10-05T00:30:32.759Z","avatar_url":"https://github.com/AI2Business.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Python Package](https://github.com/AI2Business/mkdocstrings-sourcelink/workflows/Python%20Package/badge.svg)](https://github.com/AI2Business/mkdocstrings-sourcelink/actions)\n[![GitHub branch checks state](https://img.shields.io/github/checks-status/ai2business/mkdocstrings-sourcelink/gh-pages?label=docs\u0026logo=github%20actions)](https://ai2business.github.io/mkdocstrings-sourcelink/)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/AI2Business/mkdocstrings-sourcelink/main.svg)](https://results.pre-commit.ci/latest/github/AI2Business/mkdocstrings-sourcelink/main)\n[![codecov](https://codecov.io/gh/AI2Business/mkdocstrings-sourcelink/branch/main/graph/badge.svg?token=DKE0SHCRF7)](https://codecov.io/gh/AI2Business/mkdocstrings-sourcelink)\n[![Code Style: Black](https://img.shields.io/badge/code%20style-black-black.svg)](https://github.com/ambv/black)\n[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/AI2Business/mkdocstrings-sourcelink.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/AI2Business/mkdocstrings-sourcelink/context:python)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocstrings-sourcelink?logo=python\u0026logoColor=yellow)](https://pypi.org/project/mkdocstrings-sourcelink/)\n[![PyPI](https://img.shields.io/pypi/v/mkdocstrings-sourcelink?logo=PyPi\u0026logoColor=yellow)](https://pypi.org/project/mkdocstrings-sourcelink/)\n\n# mkdocstrings-sourcelink\n\n![_](https://github.com/AI2Business/mkdocstrings-sourcelink/blob/main/docs/assets/img/export.png?raw=true)\n\n\u003e Automatic source link generation for [mkdocstrings](https://github.com/pawamoy/mkdocstrings)\n\n## Overview\n\n`mkdocstrings-sourcelink` is a source link generator for [mkdocstrings](https://github.com/pawamoy/mkdocstrings), which allows connecting the source code to a repository independent of the host ([GitHub](https://github.com), [GitLab](https://github.com), own Services).\n\nThe original idea of `mkdocstrings-sourcelink` was coming from [keras-autodoc](https://github.com/keras-team/keras-autodoc) and used as inspiration. However, this implementation focuses on using straight [mkdocstrings](https://github.com/pawamoy/mkdocstrings) and not rephrase docstrings into the documentation. Furthermore, `mkdocstrings-sourcelink` also allows:\n\n1. Generating API list\n2. Using templates and examples\n3. Importing existing markdown files like [README.md](https://github.com/AI2Business/mkdocstrings-sourcelink/blob/main/README.md)\n\n## Installation\n\n``` shell\npip install mkdocstrings-sourcelink\n```\n\n## Usage\n\nThe usage requires just three steps:\n\n1. `❯ python generate_docs.py`\n2. `❯ mkdocs.yml`\n3. `❯ mkdocs deploy`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fai2business%2Fmkdocstrings-sourcelink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fai2business%2Fmkdocstrings-sourcelink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fai2business%2Fmkdocstrings-sourcelink/lists"}