https://github.com/opensvc/docs.opensvc.com
The sphinx documentation published on https://docs.opensvc.com
https://github.com/opensvc/docs.opensvc.com
Last synced: 7 months ago
JSON representation
The sphinx documentation published on https://docs.opensvc.com
- Host: GitHub
- URL: https://github.com/opensvc/docs.opensvc.com
- Owner: opensvc
- License: apache-2.0
- Created: 2018-06-05T17:18:20.000Z (about 8 years ago)
- Default Branch: b2.1
- Last Pushed: 2024-11-12T08:00:01.000Z (over 1 year ago)
- Last Synced: 2024-11-12T09:17:42.029Z (over 1 year ago)
- Language: HTML
- Size: 21.8 MB
- Stars: 1
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docs.opensvc.com
The sphinx documentation published on https://docs.opensvc.com
Contributors should read the following doc sections:
* https://docs.opensvc.com/latest/contribute.html#contribute-translations
* https://docs.opensvc.com/latest/contribute.html#contribute-documentations
---
# development environment howto
## build docker image
`docker build -t osvcsphinx:dev .`
## launch webserver
`docker run --name osvcsphinx --rm -d -v $PWD:/data osvcsphinx:dev`
## dev & build doc
`docker exec -it osvcsphinx /bin/bash`
`cd /data ; make html`
## open your favorite browser to http://ip.of.container:8000/build/html/
CONTAINER_IP=$(docker container inspect -f '{{ .NetworkSettings.IPAddress }}' osvcsphinx)
xdg-open http://$CONTAINER_IP:8000/build/html
## stop and remove container
`docker rm -f osvcsphinx`