{"id":34632087,"url":"https://github.com/fraya/dylan-docs","last_synced_at":"2026-03-13T21:33:02.771Z","repository":{"id":220376393,"uuid":"751396972","full_name":"fraya/dylan-docs","owner":"fraya","description":"Opendylan docker container to generate documentation with Sphinx","archived":false,"fork":false,"pushed_at":"2025-03-06T10:20:05.000Z","size":23,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T11:25:56.883Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","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/fraya.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":"2024-02-01T14:32:49.000Z","updated_at":"2025-03-06T10:15:11.000Z","dependencies_parsed_at":"2024-02-01T19:18:16.817Z","dependency_job_id":"983ad9fc-d209-40cd-806e-3e9342f647e5","html_url":"https://github.com/fraya/dylan-docs","commit_stats":null,"previous_names":["fraya/dylan-docs"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/fraya/dylan-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraya%2Fdylan-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraya%2Fdylan-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraya%2Fdylan-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraya%2Fdylan-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fraya","download_url":"https://codeload.github.com/fraya/dylan-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraya%2Fdylan-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30476305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-13T20:45:58.186Z","status":"ssl_error","status_checked_at":"2026-03-13T20:45:20.133Z","response_time":60,"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":[],"created_at":"2025-12-24T16:52:43.126Z","updated_at":"2026-03-13T21:33:02.750Z","avatar_url":"https://github.com/fraya.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dylan-docs\nDocker container to generate [Opendylan](https://opendylan.org) documentation.\n\nIt is based on the [Sphinx docker\nimage](https://github.com/sphinx-doc/sphinx-docker-images) and includes:\n\n- [Dylan Sphinx extensions](https://github.com/dylan-lang/sphinx-extensions)\n\n- [Furo theme](https://github.com/pradyunsg/furo), which is the default\n  them used in Opendylan's website.\n\n- [Sphinx\n  copybutton](https://sphinx-copybutton.readthedocs.io/en/latest/) to\n  add a copy button in the right of the code blocks. See usage below.\n\n- [Sphinx PlantUML](https://github.com/sphinx-contrib/plantuml) to\n  create UML diagrams and other software development related formats\n  (see [PlantUML in Wikipedia](https://en.wikipedia.org/wiki/PlantUML)).\n  See usage below.\n\n| :exclamation: Important |\n|-------------------------|\n\nThis container requires that the path to `sphinxcontrib` in the file\n`conf.py` is exactly:\n\n    '../../_packages/sphinx-extensions/current/src/sphinxcontrib'\n\nwhich is the standard path where `dylan-tool` install the dependency.\n\n## Usage\n\nDownload image\n\n````\ndocker pull ghcr.io/fraya/dylan-docs\n````\n\nGenerate documents from directory `./docs` where a Sphinx project\nalready exists.\n\n````\ndocker run --rm -v ./docs:/docs --user \"$(id -u):$(id -g)\" ghcr.io/fraya/dylan-docs make html\n````\n\nwith `podman`\n\n```\npodman run --rm -v ./docs:/docs:z ghcr.io/fraya/dylan-docs make html\n```\n\n### Copy button\n\nTo use _copy button_ add in your `conf.py` configuration file the\n`sphinx_copybutton` to your extension list, e.g.:\n\n````python\nextensions = [\n  ...\n  'sphinx_copybutton'\n  ...\n]\n````\n\n### PlantUML\n\nAdd `sphinxcontrib.plantuml` to your extension list in your `conf.py`:\n\n```python\nextensions = [\n  'sphinxcontrib.plantuml',\n]\n```\n\nAnd specify the plantuml command (included in the image) in your\n`conf.py`:\n\n```python\nplantuml = '/usr/local/bin/plantuml'\n```\n\n### Creation of a document project\n\nTo create the structure of the documentation for a new project, we use\nthe interactive `sphinx-quickstart`.\n\nFirst, create the documentation directory\n\n````\nmkdir docs; cd docs\n````\n\nThen we call the container in an interactive way:\n\n````\npodman run --rm -ti -v ./docs:/docs:z ghcr.io/fraya/dylan-docs sphinx-quickstart\n````\n\n## Build the image\n\nTo build the image, for instance with version `0.2.0` of `sphinx-extensions`:\n\n````\ndocker build -t docker-docs:0.2.0 -t docker-docs:latest --build-arg SPHINX_EXTENSIONS_VERSION=0.2.0 .\n````\n\n## Github Packages\n\nThis package is generated in the GH Action for the current version of\nSphinx extensions and uploaded to `ghcr.io/fraya/dylan-docs`.\n\n## Why?\n\nThe process of creating the documentation in GH Actions is complex and\nrequires:\n\n- Install Sphinx doc\n\n- Install dylan-tool which requires download Opendylan.\n\n- Install the dependency of `sphinx-extensions`\n\n- Sometimes make links between the directories to adjust the path to\n  `sphinx-extensions`.\n\n- Install 'furo' theme.\n\nIn between this process will be easier once `dylan-tool` is used in\nall projects, this container makes the building of documentation\nfaster and easier.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffraya%2Fdylan-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffraya%2Fdylan-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffraya%2Fdylan-docs/lists"}