{"id":41486665,"url":"https://github.com/stephanebranly/ontodoc","last_synced_at":"2026-01-23T18:00:18.226Z","repository":{"id":288302912,"uuid":"953138744","full_name":"StephaneBranly/ontodoc","owner":"StephaneBranly","description":"📑 A python module to generate markdown documentation for ontologies.","archived":false,"fork":false,"pushed_at":"2025-08-04T18:46:34.000Z","size":139,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-05T13:23:34.545Z","etag":null,"topics":["documentation","jinja2","markdown","ontology","rdflib"],"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/StephaneBranly.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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-22T16:53:31.000Z","updated_at":"2025-06-25T17:13:18.000Z","dependencies_parsed_at":"2025-04-17T01:56:22.219Z","dependency_job_id":"a8f1f17e-92ae-438e-864e-38ac057d8aa0","html_url":"https://github.com/StephaneBranly/ontodoc","commit_stats":null,"previous_names":["stephanebranly/ontodoc"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/StephaneBranly/ontodoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StephaneBranly%2Fontodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StephaneBranly%2Fontodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StephaneBranly%2Fontodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StephaneBranly%2Fontodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StephaneBranly","download_url":"https://codeload.github.com/StephaneBranly/ontodoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StephaneBranly%2Fontodoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28697424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T17:25:48.045Z","status":"ssl_error","status_checked_at":"2026-01-23T17:25:47.153Z","response_time":59,"last_error":"SSL_read: 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","jinja2","markdown","ontology","rdflib"],"created_at":"2026-01-23T18:00:17.231Z","updated_at":"2026-01-23T18:00:18.203Z","avatar_url":"https://github.com/StephaneBranly.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src='https://raw.githubusercontent.com/StephaneBranly/ontodoc/bb6b704b03c3e470189ebedd3ec0c102dbe4177f/src/logo.png' height='200' alt='ontodoc logo' /\u003e\n\u003c/p\u003e\n\n# ontodoc\n\n[![PyPIVersion](https://img.shields.io/pypi/v/ontodoc)](https://github.com/StephaneBranly/ontodoc/releases) [![PyPI - Downloads](https://img.shields.io/pypi/dm/ontodoc)](https://pypistats.org/packages/ontodoc) [![GitHub License](https://img.shields.io/github/license/StephaneBranly/ontodoc)](https://github.com/StephaneBranly/ontodoc/blob/v0.0.1/LICENCE.txt)\n\nA python module to generate markdown documentation for ontologies.\n\nBased on `rdflib` and `jinja2`.\n\n## Getting Started 🚀\n\n### Installation\n\n```shell\npip install ontodoc\n```\n\n### Command line usage\n\n```shell\npython -m ontodoc\n```\n\nBy default, the file named `ontology.ttl` will be used to generate your documentation in the `build` destination folder.\n\nYou can easily change settings as you need.\nAvailable arguments :\n\n| Argument name                         | Default        | Description                                           | Implemented |\n| ------------------------------------- | -------------- | ----------------------------------------------------- | ----------- |\n| `-i, --input INPUT`                   | `ontology.ttl` | _Input ontology file_                                 | ✅          |\n| `-o, --output OUTPUT`                 | `build/`       | _Output directory for the generated documentation_    | ✅          |\n| `-t, --templates TEMPLATES`           | `templates/`   | _Custom templates folder_                             | ✅          |\n| `-f, --footer, --no-footer`           | `true`         | _Add footer for each page_                            | ✅          |\n| `-c, --concatenate, --no-concatenate` | `false`        | _Concatenate documentation into an unique file_       | ✅          |\n| `-s, --schema, --no-schema`           | `true`         | _Display schemas_                                     | ✅          |\n| `-m, --model MODEL`                   | `markdown`     | _Model type for the documentation. markdown, gh_wiki_ | ❌          |\n\n### Python generation\n\nYou can also generate your documentation and access parameters from python as follow :\n\n```python\nimport ontodoc\nontodoc.Documentation(input_graph='example/foaf.ttl').generate()\n```\n\n### Automatically generate your documentation\n\nYou can explore `github actions` to automatically generate and publish your documentation. If you need some inspiration to do it, check [our ontodoc github action](https://github.com/StephaneBranly/ontodoc/blob/main/.github/workflows/build_doc.yaml).\n\n## Example 👀\n\nLook at the [example for _foaf_](https://github.com/StephaneBranly/ontodoc/blob/main/example/build/homepage.md) to see what type of documentation you can easily build in 2 lines!\n\nIf you want to change the markdown templates, take a look at the structure of the [default ones](https://github.com/StephaneBranly/ontodoc/tree/main/ontodoc/templates).\n\n## How does it work ? 🔧\n\n```mermaid\n%% THIS IS A SCHEMA, IF YOU CANNOT SEE IT, PLEASE TRY TO CONSULT THIS PAGE ON GITHUB AND ON A DESKTOP WEB NAVIGATOR\nflowchart LR\n subgraph s1[\"Ontodoc\"]\n        mdhrd[\"Markdown human readable documentation\"]\n        mt[\"Markdown templates\"]\n        sod[\"Structured ontology description\"]\n        cli[\"Command Line Interface\"]\n  end\n    sod --\u003e mdhrd\n    mt --\u003e mdhrd\n    on((\"Ontology\")) --\u003e cli\n    cli --\u003e sod\n    cli -.-\u003e |*Custom templates*|mt\n\n    sod@{ shape: braces}\n    cli@{ shape: text}\n```\n\nRecognized properties available [here](https://github.com/StephaneBranly/ontodoc/blob/main/ontodoc/ontology_properties.py).\n\n## Contributing \u003c/\u003e\n\nFeel free to contribute to this open source project!\n\nWe need help to implement new features, fix bugs listed in [issues](https://github.com/StephaneBranly/ontodoc/issues).\n\nIf you have any idea, create your own issue.\n\n## License 🔓\n\n[Apache License 2.0](https://github.com/StephaneBranly/ontodoc/blob/main/LICENCE.txt)\n\n## They already have integrated Ontodoc ♥️\n\n_Comming soon..._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephanebranly%2Fontodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephanebranly%2Fontodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephanebranly%2Fontodoc/lists"}