{"id":27021841,"url":"https://github.com/fel-thomas/numkdoc","last_synced_at":"2025-08-20T06:42:27.611Z","repository":{"id":49129789,"uuid":"259069943","full_name":"fel-thomas/numkdoc","owner":"fel-thomas","description":"Mkdoc autodoc from your numpy style docstrings","archived":false,"fork":false,"pushed_at":"2025-02-09T07:21:19.000Z","size":24,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-01T14:16:15.201Z","etag":null,"topics":["mkdocs","mkdocs-plugin","numpydoc"],"latest_commit_sha":null,"homepage":"","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/fel-thomas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2020-04-26T15:49:05.000Z","updated_at":"2025-02-09T07:21:23.000Z","dependencies_parsed_at":"2025-04-04T19:54:49.438Z","dependency_job_id":"581d7152-f4dc-4e19-8a3c-bee8eef76d6f","html_url":"https://github.com/fel-thomas/numkdoc","commit_stats":null,"previous_names":["napolar/numkdoc"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fel-thomas/numkdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fel-thomas%2Fnumkdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fel-thomas%2Fnumkdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fel-thomas%2Fnumkdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fel-thomas%2Fnumkdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fel-thomas","download_url":"https://codeload.github.com/fel-thomas/numkdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fel-thomas%2Fnumkdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271279538,"owners_count":24731902,"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-08-20T02:00:09.606Z","response_time":69,"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":["mkdocs","mkdocs-plugin","numpydoc"],"created_at":"2025-04-04T19:54:44.355Z","updated_at":"2025-08-20T06:42:27.544Z","avatar_url":"https://github.com/fel-thomas.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NumKdoc\n\n[![pypi](https://github.com/fel-thomas/numkdoc/actions/workflows/pypi.yml/badge.svg)](https://github.com/fel-thomas/numkdoc/actions/workflows/pypi.yml)\n\nNumKdoc is a plugin for Mkdoc allowing you to automatically generate documentation from your Numpy style docstring, by making a simple call to classes.\n\nThis project is not maintained, and the parsing is not complete. It is based on the NumpyDoc parser.\n\n## Quick start\n\nIf you want to try this plugin as-it-is, follow these steps:\n\n1. Download this repo and (eventually) unzip it in a folder\n\n2. Inside the project folder, execute the command\n   `python setup.py develop` to install\n   the plugin on your local machine.\n\n3. Go to your mkdocs project folder, edit the `mkdocs.yml` file\n   and add these few lines at the end:\n\n   ```yaml\n   plugins:\n     - numkdoc\n   ```\n\nThat's it.\nNow you can call the parsing of a class using the tag `{{ module.ClassName }}`,\nNumkdoc will automatically substitue that tag with the class documentation.\n\n### Example\n\nFor example, you could edit the `docs/api/core.md`\nfile and insert the tag in any place, like this:\n\n```markdown\n# Core Api\n\n[...]\n\n{{ src.module.Class }}\n\n[...]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffel-thomas%2Fnumkdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffel-thomas%2Fnumkdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffel-thomas%2Fnumkdoc/lists"}