github.com/mboersma/deis@v1.13.4/docs/README.md (about) 1 # Deis Documentation 2 3 Source files for <http://docs.deis.io>, the documentation home of Deis. 4 5 Documentation in this tree consists of plain text files named with the 6 `.rst` suffix. These can be read in any text viewer, or processed by the 7 [Sphinx](http://sphinx-doc.org/) system to create an HTML version. 8 9 Please add any issues you find with this documentation to the 10 [Deis project](https://github.com/deis/deis/issues). 11 12 ## Usage 13 14 1. Install Sphinx and other requirements: 15 16 ```console 17 $ virtualenv venv -q --prompt='(docs)' && . venv/bin/activate 18 (docs)$ pip install -r docs_requirements.txt 19 ``` 20 21 2. Build the documentation and host it on a local web server: 22 23 ```console 24 (docs)$ make server 25 sphinx-build -b dirhtml -d _build/doctrees . _build/dirhtml 26 Making output directory... 27 Running Sphinx v1.3.0 28 ... 29 Build finished. The HTML pages are in _build/dirhtml. 30 Serving HTTP on 0.0.0.0 port 8000 ... 31 ``` 32 33 3. Open a web browser to http://127.0.0.1:8000/ and learn about Deis, 34 a lightweight, flexible and powerful open source PaaS. 35 36 4. Fork this repository and send your changes or additions to Deis' 37 documentation as GitHub 38 [Pull Requests](https://github.com/deis/deis/pulls). Thank you!