{"id":21338670,"url":"https://github.com/josttim/auto_fast_docs","last_synced_at":"2026-04-29T12:00:47.005Z","repository":{"id":215840574,"uuid":"626955994","full_name":"JostTim/auto_fast_docs","owner":"JostTim","description":"Generate static webside for your code documentation, with fast setup and no extra documentation effort. It is based on the great mkdocs, mkdocs-material and mkdocstrings packages","archived":false,"fork":false,"pushed_at":"2024-01-09T14:29:29.000Z","size":672,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-24T22:52:16.690Z","etag":null,"topics":["ci-cd","documentation","mkdocs","mkdocs-material","mkdocstrings"],"latest_commit_sha":null,"homepage":"https://josttim.github.io/auto_fast_docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JostTim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-04-12T13:50:00.000Z","updated_at":"2025-08-29T14:11:33.000Z","dependencies_parsed_at":"2024-01-08T05:49:05.184Z","dependency_job_id":"94b47d90-52fd-48b0-8abd-4faa8c5b60bd","html_url":"https://github.com/JostTim/auto_fast_docs","commit_stats":null,"previous_names":["josttim/auto-doc"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/JostTim/auto_fast_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JostTim%2Fauto_fast_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JostTim%2Fauto_fast_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JostTim%2Fauto_fast_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JostTim%2Fauto_fast_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JostTim","download_url":"https://codeload.github.com/JostTim/auto_fast_docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JostTim%2Fauto_fast_docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32424499,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T11:26:24.167Z","status":"ssl_error","status_checked_at":"2026-04-29T11:26:13.719Z","response_time":110,"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":["ci-cd","documentation","mkdocs","mkdocs-material","mkdocstrings"],"created_at":"2024-11-22T00:34:29.375Z","updated_at":"2026-04-29T12:00:46.983Z","avatar_url":"https://github.com/JostTim.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Upload Python Package](https://github.com/JostTim/auto_fast_docs/actions/workflows/python-publish.yml/badge.svg?branch=main)](https://github.com/JostTim/auto_fast_docs/actions/workflows/python-publish.yml)\n[![Deploy](https://github.com/JostTim/auto_fast_docs/actions/workflows/ci-cd.yml/badge.svg?branch=main)](https://github.com/JostTim/auto_fast_docs/actions/workflows/ci-cd.yml)\n\n# Automatic documentation for your python repository. \nWith fast setup and no extra effort.\nThis package is designed to be ran in containerized CI/CD.\n\nIt's purpose is quite simple : \nleveraging mkdocs, mkdocs-material and mkdocstrings, and scanning your repository's pyhton source files.  \nWhen it finds a function or class, it groups it nicely, and generates folders and markdown files with the appropriate mkdocstrings headers, inside a `docs` folder, used for the static website generation on github or gitlab pages.\n\nThis folder will not appear in your repo if you run this package in a github/gitlab  CI/CD container, but will still exist at container runtime to generate and publish the website.\n\n## Usage \n\nDrop it on top level of your package wrapper folder, and add two lines in your github/gitlab [ci/cd file](https://github.com/JostTim/auto_fast_docs/blob/main/.github/workflows/ci-cd.yml) : (click the link to see a working example, that built [this present repo's documentation page](https://josttim.github.io/auto_fast_docs/))\n\n```bash\npip install auto_fast_docs\nauto_fast_docs MyPackage\n```\n\n**I strongly recommand giving it your username so that it can also build an mkdocs.yml file by itself !**\n\n```bash\npip install auto_fast_docs\nauto_fast_docs MyPackage --username MyGtihubUsername\n```\n\n## Check the result\n\n[Here is an example of the result](https://josttim.github.io/auto_fast_docs/) (and also a documentation for this repo's code)\n\n## Install\n\nPypi releases : https://pypi.org/project/auto-fast-docs/\n\n```bash\npip install auto_fast_docs\n```\n\nor most recent commit from github :\n\n```bash\npip install git+https://github.com/JostTim/auto_fast_docs.git\n```\n\n## Options :\n\nIt supports a few options to simplify your dev life even more and be platform a-specific: \n\nAll options are case insensitive, except for the positionnal argument package_name\n\n### --username\nName of the user that owns the repository.\nIf it is supplied and no ``mkdocs.yml`` file is present in the repo, auto_fast_doc will attempt to fill in the information automatically. If you don't supply this info, it will not generate the mkocs.yml file by itself.\n```bash\nauto_fast_docs MyPackage --username MyUsername \n```\n\n### --layout\nFlat or src layout style of your code in the repository. By default, `layout=\"flat\"`\n\n```bash\nauto_fast_docs MyPackage --layout src \n```\n\nThe flat layout structure is standardized like this :\n\n\u003e - :open_file_folder: PackageRepo\n\u003e   - :page_facing_up: setup.py\n\u003e   - :page_facing_up: pyproject.toml\n\u003e   - :page_facing_up: mkdocs.yml\n\u003e   - :open_file_folder: docs\n\u003e     - :page_facing_up: index.md\n\u003e   - :open_file_folder: Package\n\u003e     - :page_facing_up: \\_\\_init__.py\n\u003e     - :page_facing_up: myfile.py\n\u003e     - :open_file_folder: mysubpackage\n\u003e       - :page_facing_up: \\_\\_init__.py\n\u003e       - :page_facing_up: myfile2.py\n    \nWhile the src layout is standardized like this :\n\n\u003e - :open_file_folder: PackageRepo\n\u003e   - :page_facing_up: setup.py\n\u003e   - :page_facing_up: pyproject.toml\n\u003e   - :page_facing_up: mkdocs.yml\n\u003e   - :open_file_folder: docs\n\u003e     - :page_facing_up: index.md\n\u003e   - :open_file_folder: src\n\u003e     - :open_file_folder: Package\n\u003e       - :page_facing_up: \\_\\_init__.py\n\u003e       - :page_facing_up: myfile.py\n\u003e       - :open_file_folder: mysubpackage\n\u003e         - :page_facing_up: \\_\\_init__.py\n\u003e         - :page_facing_up: myfile2.py\n\nNote that auto_fast_docs doesn't care about ``pyproject.toml`` or ``setup.py``, any can be used.\nAlso note that the docs folder, and the mkdocs.yml file here are both also not necessary, if you supply at least the ``--username`` option (see above)  \n(and of course, if you are on github on a user hosted repo. Otherwise, see ``--platform`` and ``--groups`` options below)\n\n### --platform\nThe platform (``github`` or ``gitlab``) on wich you are building the pages into.\nThe default is ``github``\n\n```bash\nauto_fast_docs MyPackage --platform gitlab \n```\n\nNote that in the case of gitlab, if you are not on the central gitlab.com repository but on a instance hosted by a compagny, you can supply the suffix after gitlab, separated with a semicolon ``:``\n\n```bash\nauto_fast_docs MyPackage --platform gitlab:pasteur.fr\n```\n\nBy default, if nothing is supplied with a semicolon after the platform name, the suffix is set to `com` (giving out github.com and gitlab.com)\n\n### --groups\nIf your repository is not in your own package, you must supply the group name.(that's the organization name on github)\n\n```bash\nauto_fast_docs MyPackage --platform gitlab:pasteur.fr --groups mymaingroup/mysubgroup \n```\n\nNote that if group is used, it is still necessary to supply the username - even thoug it is not used for the repository path assembly - if you want the ``mkdocs.yml`` file to be generated.\n\nIn the case of gitlab, an arbitrary number of groups can be nested (while github doesn't allow nested organizations). Simmply separate them using forward slashes `/` and auto_fast_docs should manage to assemble the final path by itself, depending on your platform.\n\n_____\n\n## Small note :\nOn github, you will also need :\n- to allow Read and write permissions for workflow in your repo settings, under  \n  ``settings \u003e actions \u003e general \u003e Workflow permissions``\n- to set the pages deployments branch to gh-pages, under :  \n  ``settings \u003e pages \u003e Build and deployment \u003e Source`` to `deploy from a branch` and  \n  ``settings \u003e pages \u003e Build and deployment \u003e  Branch`` to your `gh-pages` branch  \n  (this branch will appear after the first sucessfull mkocs build, except if you created it yourself.)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosttim%2Fauto_fast_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosttim%2Fauto_fast_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosttim%2Fauto_fast_docs/lists"}