{"id":20355959,"url":"https://github.com/hedzr/sphinx-builder","last_synced_at":"2026-05-07T12:33:25.563Z","repository":{"id":168890121,"uuid":"644703767","full_name":"hedzr/sphinx-builder","owner":"hedzr","description":"extending official sphinx docker image with usesful plugins","archived":false,"fork":false,"pushed_at":"2023-05-26T01:12:57.000Z","size":29,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-04T17:41:14.911Z","etag":null,"topics":["docker-container","docker-image","sphinx-builder","sphinx-doc","sphinx-documentation"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","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/hedzr.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}},"created_at":"2023-05-24T04:49:31.000Z","updated_at":"2023-06-03T06:56:35.000Z","dependencies_parsed_at":"2024-02-16T04:34:49.771Z","dependency_job_id":null,"html_url":"https://github.com/hedzr/sphinx-builder","commit_stats":null,"previous_names":["hedzr/sphinx-builder"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/hedzr/sphinx-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hedzr","download_url":"https://codeload.github.com/hedzr/sphinx-builder/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-builder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32737834,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"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":["docker-container","docker-image","sphinx-builder","sphinx-doc","sphinx-documentation"],"created_at":"2024-11-14T23:14:36.111Z","updated_at":"2026-05-07T12:33:25.538Z","avatar_url":"https://github.com/hedzr.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinx-builder\n\n[![build](https://github.com/hedzr/sphinx-builder/actions/workflows/docker-image.yml/badge.svg)](https://github.com/hedzr/sphinx-builder/actions/workflows/docker-image.yml)\u003c!--\n![release](https://img.shields.io/github/v/release/hedzr/sphinx-builder) --\u003e\n[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/hedzr/sphinx-builder.svg?label=release)](https://github.com/hedzr/sphinx-builder/releases)\n[![Docker Pulls](https://img.shields.io/docker/pulls/hedzr/sphinx-builder)](https://hub.docker.com/r/hedzr/sphinx-builder)\n![Docker Image Version (latest semver)](https://img.shields.io/docker/v/hedzr/sphinx-builder)\n![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/hedzr/sphinx-builder)\n\nThis is a docker container image for sphinx building. It extends official sphinx docker image `sphinxdoc/sphinx`([@GitHub](https://www.github.com/sphinx-doc/docker)) with usesful plugins.\n\nThese modules are included (see `RELEASE` for latest versions):\n\n- ...\n- Sphinx                       : 5.3.0\n- sphinx-autobuild             : 2021.3.14\n- sphinx-basic-ng              : 1.0.0b1\n- sphinx-book-theme            : 1.0.1\n- sphinx-copybutton            : 0.5.2\n- sphinx_design                : 0.4.1\n- sphinx-intl                  : 2.1.0\n- sphinx-rtd-theme             : 1.2.1\n- sphinx-tabs                  : 3.4.1\n- sphinx-thebe                 : 0.2.1\n- sphinx-togglebutton          : 0.3.2\n- sphinxcontrib-applehelp      : 1.0.2\n- sphinxcontrib-devhelp        : 1.0.2\n- sphinxcontrib-htmlhelp       : 2.0.0\n- sphinxcontrib-jquery         : 4.1\n- sphinxcontrib-jsmath         : 1.0.1\n- sphinxcontrib-mermaid        : 0.8.1\n- sphinxcontrib-qthelp         : 1.0.3\n- sphinxcontrib-serializinghtml: 1.1.5\n- sphinxext-opengraph          : 0.8.2\n- sphinxext-rediraffe          : 0.2.7\n- ...\n- breathe                      : 4.35.0\n- linkify-it-py                : 2.0.2\n- markdown-it-py               : 2.1.0\n- matplotlib                   : 3.7.1\n- myst-nb                      : 0.17.2\n- myst-parser                  : 0.18.1\n- numpy                        : 1.24.3\n\nThese sphinx themes are pre-included:\n\n- sphinx-book-theme\u003e=1.0.1\n- sphinx-rtd-theme\u003e=1.2.0\n- furo\u003e=2023.3.27\n\n## Usage\n\nCreate a Sphinx project:\n\n```bash\ndocker run -it --rm -v /path/to/document:/docs hedzr/sphinx-builder sphinx-quickstart\n```\n\nBuild HTML document:\n\n```bash\ndocker run --rm -v /path/to/document:/docs hedzr/sphinx-builder make html\n```\n\nBuild EPUB document:\n\n```bash\ndocker run --rm -v /path/to/document:/docs hedzr/sphinx-builder make epub\n```\n\nBuild PDF document [**NOT YET**]:\n\n```bash\ndocker run --rm -v /path/to/document:/docs hedzr/sphinx-builder:latexpdf make latexpdf\n```\n\n### Tips\n\nTo install additional dependencies, use ``hedzr/sphinx-builder`` as a base image:\n\n```dockerfile\n# in your Dockerfile\nFROM sphinxdoc/sphinx\n\nWORKDIR /docs\nADD requirements.txt /docs\nRUN pip3 install -r requirements.txt\n```\n\n## Information\n\n### Known packages (py3)\n\n```bash\n#8 149.0 Package                       Version\n#8 149.0 ----------------------------- ---------\n#8 149.0 accessible-pygments           0.0.4\n#8 149.0 alabaster                     0.7.12\n#8 149.0 asttokens                     2.2.1\n#8 149.0 attrs                         23.1.0\n#8 149.0 Babel                         2.10.3\n#8 149.0 backcall                      0.2.0\n#8 149.0 beautifulsoup4                4.12.2\n#8 149.0 breathe                       4.35.0\n#8 149.0 certifi                       2022.9.24\n#8 149.0 charset-normalizer            2.1.1\n#8 149.0 click                         8.1.3\n#8 149.0 colorama                      0.4.6\n#8 149.0 comm                          0.1.3\n#8 149.0 contourpy                     1.0.7\n#8 149.0 cycler                        0.11.0\n#8 149.0 debugpy                       1.6.7\n#8 149.0 decorator                     5.1.1\n#8 149.0 docutils                      0.18.1\n#8 149.0 executing                     1.2.0\n#8 149.0 fastjsonschema                2.17.1\n#8 149.0 fonttools                     4.39.4\n#8 149.0 furo                          2023.3.27\n#8 149.0 greenlet                      2.0.2\n#8 149.0 idna                          3.4\n#8 149.0 imagesize                     1.4.1\n#8 149.0 importlib-metadata            6.6.0\n#8 149.0 ipykernel                     6.23.1\n#8 149.0 ipython                       8.13.2\n#8 149.0 jedi                          0.18.2\n#8 149.0 Jinja2                        3.1.2\n#8 149.0 jsonschema                    4.17.3\n#8 149.0 jupyter-cache                 0.6.1\n#8 149.0 jupyter_client                8.2.0\n#8 149.0 jupyter_core                  5.3.0\n#8 149.0 kiwisolver                    1.4.4\n#8 149.0 linkify-it-py                 2.0.2\n#8 149.0 livereload                    2.6.3\n#8 149.0 markdown-it-py                2.2.0\n#8 149.0 MarkupSafe                    2.1.1\n#8 149.0 matplotlib                    3.7.1\n#8 149.0 matplotlib-inline             0.1.6\n#8 149.0 mdit-py-plugins               0.3.5\n#8 149.0 mdurl                         0.1.2\n#8 149.0 myst-nb                       0.17.2\n#8 149.0 myst-parser                   0.18.1\n#8 149.0 nbclient                      0.7.4\n#8 149.0 nbformat                      5.8.0\n#8 149.0 nest-asyncio                  1.5.6\n#8 149.0 numpy                         1.24.3\n#8 149.0 packaging                     21.3\n#8 149.0 parso                         0.8.3\n#8 149.0 pexpect                       4.8.0\n#8 149.0 pickleshare                   0.7.5\n#8 149.0 Pillow                        9.2.0\n#8 149.0 pip                           22.3\n#8 149.0 platformdirs                  3.5.1\n#8 149.0 prompt-toolkit                3.0.38\n#8 149.0 psutil                        5.9.4\n#8 149.0 ptyprocess                    0.7.0\n#8 149.0 pure-eval                     0.2.2\n#8 149.0 pydata-sphinx-theme           0.13.3\n#8 149.0 Pygments                      2.13.0\n#8 149.0 pyparsing                     3.0.9\n#8 149.0 pyrsistent                    0.19.3\n#8 149.0 python-dateutil               2.8.2\n#8 149.0 pytz                          2022.4\n#8 149.0 PyYAML                        6.0\n#8 149.0 pyzmq                         25.0.2\n#8 149.0 requests                      2.28.1\n#8 149.0 setuptools                    63.2.0\n#8 149.0 six                           1.16.0\n#8 149.0 snowballstemmer               2.2.0\n#8 149.0 soupsieve                     2.4.1\n#8 149.0 Sphinx                        5.3.0\n#8 149.0 sphinx-autobuild              2021.3.14\n#8 149.0 sphinx-basic-ng               1.0.0b1\n#8 149.0 sphinx-book-theme             1.0.1\n#8 149.0 sphinx-copybutton             0.5.2\n#8 149.0 sphinx_design                 0.4.1\n#8 149.0 sphinx-intl                   2.1.0\n#8 149.0 sphinx-rtd-theme              1.2.1\n#8 149.0 sphinx-tabs                   3.4.1\n#8 149.0 sphinx-thebe                  0.2.1\n#8 149.0 sphinx-togglebutton           0.3.2\n#8 149.0 sphinxcontrib-applehelp       1.0.2\n#8 149.0 sphinxcontrib-devhelp         1.0.2\n#8 149.0 sphinxcontrib-htmlhelp        2.0.0\n#8 149.0 sphinxcontrib-jquery          4.1\n#8 149.0 sphinxcontrib-jsmath          1.0.1\n#8 149.0 sphinxcontrib-mermaid         0.8.1\n#8 149.0 sphinxcontrib-qthelp          1.0.3\n#8 149.0 sphinxcontrib-serializinghtml 1.1.5\n#8 149.0 sphinxext-opengraph           0.8.2\n#8 149.0 sphinxext-rediraffe           0.2.7\n#8 149.0 SQLAlchemy                    2.0.15\n#8 149.0 stack-data                    0.6.2\n#8 149.0 tabulate                      0.9.0\n#8 149.0 tornado                       6.3.2\n#8 149.0 traitlets                     5.9.0\n#8 149.0 typing_extensions             4.6.1\n#8 149.0 uc-micro-py                   1.0.2\n#8 149.0 urllib3                       1.26.12\n#8 149.0 wcwidth                       0.2.6\n#8 149.0 wheel                         0.37.1\n#8 149.0 zipp                          3.15.0\n```\n\n## LICENSE\n\nApache 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhedzr%2Fsphinx-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhedzr%2Fsphinx-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhedzr%2Fsphinx-builder/lists"}