{"id":20200406,"url":"https://github.com/nickjer/docker-sphinx","last_synced_at":"2025-03-03T08:43:02.027Z","repository":{"id":70912301,"uuid":"84617791","full_name":"nickjer/docker-sphinx","owner":"nickjer","description":"Sphinx documentation builder with extras in a Docker container","archived":false,"fork":false,"pushed_at":"2018-04-19T13:32:51.000Z","size":8,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-13T20:14:32.199Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nickjer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2017-03-11T02:30:18.000Z","updated_at":"2020-02-01T08:51:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"c7b8442c-a44a-466a-af37-76bd48cf8085","html_url":"https://github.com/nickjer/docker-sphinx","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/nickjer%2Fdocker-sphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fdocker-sphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fdocker-sphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fdocker-sphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nickjer","download_url":"https://codeload.github.com/nickjer/docker-sphinx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241637152,"owners_count":19994925,"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":[],"created_at":"2024-11-14T04:43:33.447Z","updated_at":"2025-03-03T08:43:02.003Z","avatar_url":"https://github.com/nickjer.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker Sphinx\n\n[![Build Status](https://travis-ci.org/nickjer/docker-sphinx.svg?branch=master)](https://travis-ci.org/nickjer/docker-sphinx)\n[![Docker Build Status](https://img.shields.io/docker/build/nickjer/docker-sphinx.svg)](https://hub.docker.com/r/nickjer/docker-sphinx/)\n[![GitHub License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\nDocker image for [Sphinx](http://www.sphinx-doc.org/en/stable/).\n\nThis image contains:\n\n- [Sphinx](http://www.sphinx-doc.org/en/stable/)\n- A variety of themes:\n  - [Alabaster](http://alabaster.readthedocs.io/en/latest/)\n  - [Sphinx Bootstrap Theme](http://ryan-roemer.github.io/sphinx-bootstrap-theme/README.html)\n  - [sphinx_rtd_theme](https://github.com/rtfd/sphinx_rtd_theme)\n- A markdown parser for reStructuredText ([recommonmark](https://github.com/rtfd/recommonmark))\n- A sphinx watcher tool ([sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild/))\n- A variety of plugins:\n  - [sphinx-prompt](https://github.com/sbrunner/sphinx-prompt)\n  - [sphinxcontrib-actdiag](https://pypi.python.org/pypi/sphinxcontrib-actdiag)\n  - [sphinxcontrib-blockdiag](https://pypi.python.org/pypi/sphinxcontrib-blockdiag)\n  - [sphinxcontrib-nwdiag](https://pypi.python.org/pypi/sphinxcontrib-nwdiag)\n  - [sphinxcontrib-seqdiag](https://pypi.python.org/pypi/sphinxcontrib-seqdiag)\n  - [sphinxcontrib-plantuml](https://pypi.python.org/pypi/sphinxcontrib-plantuml)\n  - [sphinxcontrib-exceltable](https://pypi.python.org/pypi/sphinxcontrib-exceltable)\n  - [sphinxcontrib-googleanalytics](https://pypi.python.org/pypi/sphinxcontrib-googleanalytics)\n  - [sphinxcontrib-googlechart](https://pypi.python.org/pypi/sphinxcontrib-googlechart)\n  - [sphinxcontrib-googlemaps](https://pypi.python.org/pypi/sphinxcontrib-googlemaps)\n  - [sphinxcontrib-httpdomain](https://pypi.python.org/pypi/sphinxcontrib-httpdomain)\n- Latex to generate PDF documents\n\n## Build\n\n```sh\ngit clone https://github.com/nickjer/docker-sphinx.git\ncd docker-sphinx\ndocker build --force-rm -t nickjer/docker-sphinx .\n```\n\n## Install\n\n```sh\ndocker pull nickjer/docker-sphinx\n```\n\n## Usage\n\n```sh\ndocker run --rm -i -t -v \"${PWD}:/doc\" -u \"$(id -u):$(id -g)\" nickjer/docker-sphinx \u003ccmd\u003e\n```\n\n### Docker Compose\n\nIt is recommended to use [Docker Compose](https://docs.docker.com/compose/). An\nexample `docker-compose.yml` is seen as:\n\n```yaml\nversion: \"2\"\nservices:\n  sphinx:\n    image: \"nickjer/docker-sphinx\"\n    volumes:\n      - \"${PWD}:/doc\"\n    user: \"1000:1000\"\n```\n\nThen run:\n\n```sh\ndocker-compose run --rm sphinx \u003ccmd\u003e\n```\n\nExamples:\n\n```sh\ndocker-compose run --rm sphinx sphinx-quickstart\ndocker-compose run --rm sphinx make html\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickjer%2Fdocker-sphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickjer%2Fdocker-sphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickjer%2Fdocker-sphinx/lists"}