{"id":18684848,"url":"https://github.com/j-sephb-lt-n/python-auto-documentation-with-mkdocstrings","last_synced_at":"2026-04-13T12:31:08.911Z","repository":{"id":208386507,"uuid":"721289495","full_name":"J-sephB-lt-n/python-auto-documentation-with-mkdocstrings","owner":"J-sephB-lt-n","description":"An illustration of automatic project documentation using mkdocs","archived":false,"fork":false,"pushed_at":"2023-11-21T20:28:39.000Z","size":599,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-18T18:17:34.515Z","etag":null,"topics":["documentation","github-actions","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":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/J-sephB-lt-n.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-11-20T18:45:52.000Z","updated_at":"2023-11-22T07:37:59.000Z","dependencies_parsed_at":"2024-11-07T10:30:13.831Z","dependency_job_id":null,"html_url":"https://github.com/J-sephB-lt-n/python-auto-documentation-with-mkdocstrings","commit_stats":null,"previous_names":["j-sephb-lt-n/python-auto-documentation-with-mkdocstrings"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/J-sephB-lt-n/python-auto-documentation-with-mkdocstrings","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J-sephB-lt-n%2Fpython-auto-documentation-with-mkdocstrings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J-sephB-lt-n%2Fpython-auto-documentation-with-mkdocstrings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J-sephB-lt-n%2Fpython-auto-documentation-with-mkdocstrings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J-sephB-lt-n%2Fpython-auto-documentation-with-mkdocstrings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/J-sephB-lt-n","download_url":"https://codeload.github.com/J-sephB-lt-n/python-auto-documentation-with-mkdocstrings/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J-sephB-lt-n%2Fpython-auto-documentation-with-mkdocstrings/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31752999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","github-actions","mkdocs","mkdocs-material","mkdocstrings","python"],"created_at":"2024-11-07T10:19:31.547Z","updated_at":"2026-04-13T12:31:08.893Z","avatar_url":"https://github.com/J-sephB-lt-n.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Auto-Generated Python Project Documentation with MkDocs\n\nThis repo is my investigation of automatic python project documentation using [MkDocs](https://github.com/mkdocs/mkdocs), [MkDocStrings](https://github.com/mkdocstrings/mkdocstrings) and [Material for MkDocs](https://github.com/squidfunk/mkdocs-material). The documentation is then hosted on [GitHub pages](https://pages.github.com), with automatic deployment using [GitHub Actions](https://docs.github.com/en/actions). \n\nThe structure of this repo is from the [Real Python](https://realpython.com) tutorial [Build Your Python Project Documentation With MkDocs](https://realpython.com/python-project-documentation-with-mkdocs/). \n\nYou can browse the static build of the documentation here: https://J-sephB-lt-n.github.io/python-auto-documentation-with-mkdocstrings/\n\n# Instructions/Explanation of the Documentation Process \n\n* Refer to [requirements.txt](./requirements.txt) for the required packages.\n\n* The initial MkDocs files were created by running \u003ccode\u003emkdocs new .\u003c/code\u003e in terminal from the root project directory. This command creates the files [makedocs.yml](./makedocs.yml) and [/docs/index.md](./docs/index.md).\n\n* [makedocs.yml](./makedocs.yml) contains settings controlling the documentation style and behaviour.\n\n* This code in [makedocs.yml](./makedocs.yml) enables the documentation to automatically extract information from the docstrings in the code itself: \n\n```yaml\nplugins:\n  - mkdocstrings\n```\n\n* In order to specify which docstrings should be included in the documentation, add links into the markdown using the triple-colon format e.g. \u003ccode\u003e::: link.to.python.module\u003c/code\u003e\n\n* The documentation is built by combining and rendering the markdown files in the [/docs/](./docs/) folder.\n\n* The documentation can be hosted locally by running \u003ccode\u003emkdocs serve\u003c/code\u003e in terminal from the root project directory (view the documentation in the browser by going to the localhost URL specified - it will be something like http://localhost:8000).\n\n* The documentation can be rendered into static html using the terminal command \u003ccode\u003emkdocs build\u003c/code\u003e. The output is written to the folder [/site/](./site/), which should be added to the [.gitignore](./.gitignore) file.\n\n* If the project code is already inside a GitHub repository, the documentation can be hosted (for free) on GitHub pages (at the url https://your-user-name.github.io/your-repo-name/) by running the terminal command \u003ccode\u003emkdocs gh-deploy\u003c/code\u003e.\n\n# Automatic GitHub Deployment of Documentation\n\nAdding the yaml file [.github/workflows/deploy_documentation.yml](./.github/workflows/deploy_documentation.yml) causes the documentation to be automatically deployed (i.e. runs the code \u003ccode\u003emkdocs gh-deploy\u003c/code\u003e) whenever there is a push to the main branch of this repo.\n\nNote also that for this process to work, you need to give GitHub actions \"Read and Write permissions\" on this repo. I did this using the GitHub website GUI - the setting is available under Settings-\u003eActions-\u003eGeneral.\n\n# References \n\n* https://realpython.com/python-project-documentation-with-mkdocs/\n\n* https://numpydoc.readthedocs.io/en/latest\n\n* https://blog.elmah.io/deploying-a-mkdocs-documentation-site-with-github-actions/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj-sephb-lt-n%2Fpython-auto-documentation-with-mkdocstrings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fj-sephb-lt-n%2Fpython-auto-documentation-with-mkdocstrings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj-sephb-lt-n%2Fpython-auto-documentation-with-mkdocstrings/lists"}