{"id":23458290,"url":"https://github.com/bwibo/sphinx-rtd-docker","last_synced_at":"2025-04-11T13:54:53.095Z","repository":{"id":92308626,"uuid":"339366165","full_name":"BWibo/sphinx-rtd-docker","owner":"BWibo","description":"Dockerfile for compiling Sphinx with ReadTheDocs","archived":false,"fork":false,"pushed_at":"2023-04-30T06:59:11.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T23:25:44.501Z","etag":null,"topics":["dockerfile","readthedocs","rtd","sphinx","sphinx-copybutton","sphinx-emoji","sphinx-extension"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/BWibo.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}},"created_at":"2021-02-16T10:47:13.000Z","updated_at":"2021-12-15T10:43:19.000Z","dependencies_parsed_at":"2023-05-06T06:52:29.686Z","dependency_job_id":null,"html_url":"https://github.com/BWibo/sphinx-rtd-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWibo%2Fsphinx-rtd-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWibo%2Fsphinx-rtd-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWibo%2Fsphinx-rtd-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWibo%2Fsphinx-rtd-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BWibo","download_url":"https://codeload.github.com/BWibo/sphinx-rtd-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248412165,"owners_count":21099067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["dockerfile","readthedocs","rtd","sphinx","sphinx-copybutton","sphinx-emoji","sphinx-extension"],"created_at":"2024-12-24T05:19:29.754Z","updated_at":"2025-04-11T13:54:53.054Z","avatar_url":"https://github.com/BWibo.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker image for Sphinx and ReadTheDocs\n\n`Dockerfile` for [Sphinx](https://www.sphinx-doc.org/en/master/) including following extensions:\n\n* Sphinx ReadTheDocs Theme: [`sphinx_rtd_theme`](https://github.com/readthedocs/sphinx_rtd_theme)\n* Copy burron [`sphinx_copybutton`](https://github.com/executablebooks/sphinx-copybutton)\n* Sphinx emojies [`sphinxemoji`](https://github.com/sphinx-contrib/emojicodes)\n* Sphinx Fontwaesome [`sphinx_fontawesome`](https://pypi.org/project/sphinx_fontawesome/)\n* Sphinx Toolbox [`sphinx-toolbox`]([sphinx-toolbox](https://pypi.org/project/sphinx-toolbox))\n\nThe image is available on DockerHub: https://hub.docker.com/repository/docker/bwibo/sphinx-rtd\n\n## Usage\n\nMount your local `docs` folder to `/docs` inside the container and append the command you want to use.\nMore info on the available commands is available in the documentation of the base image:\nhttps://hub.docker.com/r/sphinxdoc/sphinx\n\n```bash\n# Build HTML docs\ndocker run --rm \\\n    -v $PWD:/docs \\\n  bwibo/sphinx-rtd make html\n```\n\n## Build\n\nRun `build.sh` to build the image or:\n\n```bash\ndocker build -t bwibo/sphinx-rtd --build-arg SPHINX_VERSION=6.2.1 .\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbwibo%2Fsphinx-rtd-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbwibo%2Fsphinx-rtd-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbwibo%2Fsphinx-rtd-docker/lists"}