https://github.com/mekras/sphinx-doc
Docker image of Sphinx documentation generator
https://github.com/mekras/sphinx-doc
docker-image sphinx-doc
Last synced: about 2 months ago
JSON representation
Docker image of Sphinx documentation generator
- Host: GitHub
- URL: https://github.com/mekras/sphinx-doc
- Owner: mekras
- License: mit
- Created: 2019-02-13T12:21:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-10-22T09:47:13.000Z (8 months ago)
- Last Synced: 2025-10-22T11:22:11.418Z (8 months ago)
- Topics: docker-image, sphinx-doc
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Образ Docker для генератора документации Sphinx
Основывается на [sphinxdoc/sphinx-latexpdf](https://hub.docker.com/r/sphinxdoc/sphinx-latexpdf)
и дополнительно включает:
- поддержку русского языка;
- [sphinx-autobuild](https://github.com/executablebooks/sphinx-autobuild);
- поддержку [PlantUML](https://plantuml.com/ru/)
([sphinxcontrib-plantuml](https://github.com/sphinx-contrib/plantuml));
- тему оформления [Read The Docs](https://sphinx-rtd-theme.readthedocs.io/en/stable/).
Рабочая папка Sphinx — `/docs`.
Запуск сервера для разработки:
docker run \
-v /path/to/src:/docs \
--rm -p 8000:8000 \
-it mekras/sphinx-doc:latest \
sphinx-autobuild --host 0.0.0.0 /docs /var/www/html/pages
Здесь:
- `/path/to/src` — путь к исходным файлам вашей документации;
- `-p 8000:8000` — первое число (**8000**:8000) задаёт порт для подключения к веб-серверу с машины разработчика.
После этого веб-сервер будет доступен по адресу `http://localhost:8000`.