Commit Graph

2672 Commits

Author SHA1 Message Date
James Turnbull 98b39c91de Added Reference Manual
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:19 +00:00
Paul fb17f9fcab Mac OSX command for pip was incorrect 2017-06-02 00:06:19 +00:00
Sven Dowideit 2d576ea3b6 make docs is more consistent 2017-06-02 00:06:19 +00:00
Sven Dowideit 3091ba88fa change the policy wrt $ sudo docker to simplify auto-testing 2017-06-02 00:06:19 +00:00
John Feminella 01d4e98cc8 Corrects misspellings of 'Sphinx' 2017-06-02 00:06:19 +00:00
John Feminella b52c999103 Suggest users install dependencies by using requirements.txt, not manually 2017-06-02 00:06:19 +00:00
Sven Dowideit 23e91a6d7f add links to the Dockerfiles as canonical external requirements, add example of building and exposing the docs and simplify the Dockerfile for cacheability 2017-06-02 00:06:19 +00:00
Andy Rothfusz bed37d2204 Clean up level 3 headers. 2017-06-02 00:06:19 +00:00
Andy Rothfusz ce220ef43b Fix #1919 document how to edit and release docs. 2017-06-02 00:06:19 +00:00
Pascal Borreli 147b04ce2b Fixed typos 2017-06-02 00:06:19 +00:00
Thatcher Peskens 22ab3ddc8a Fixed some typo's and formatting issues in remote api documentation. 2017-06-02 00:06:19 +00:00
Thatcher 2216afb617 Some more improvements on the docs readme. Removed references to website. 2017-06-02 00:06:19 +00:00
Thatcher Peskens 9c5f4391e1 Updated docs README with instructions to preview the generated manfile, and where to get the one generated by sphinx. 2017-06-02 00:06:19 +00:00
Thatcher Peskens 77926c6033 Enabled the docs to generate manpages.
* changed conf.py to reference toctree.rst instead of index
* Added note to README to upgrade your sphinx to the latest version to prevent a bug with .. note:: blocks.
2017-06-02 00:06:19 +00:00
Daniel Gasienica 74428120af Make style consistent 2017-06-02 00:06:19 +00:00
Daniel Gasienica 3c035fa508 Add Mac OS X instructions for doc tools 2017-06-02 00:06:19 +00:00
Daniel Gasienica 99dfa4e7e8 Add `make server` command to preview docs 2017-06-02 00:06:18 +00:00
Thatcher Peskens 6d79cab514 Updated index to reflect new (short) 'engine' message (merged with solomon's new text), also moved around the layout a bit and fixed some small text errors. 2017-06-02 00:06:18 +00:00
Thatcher Peskens f4399fe403 Added code and color for 'note' and updated the hello world note. 2017-06-02 00:06:18 +00:00
Thatcher Peskens 8a39a45f05 Improved README 2017-06-02 00:06:18 +00:00
Thatcher Peskens 244477e27f Merge of docker-website into the docker documentation. 2017-06-02 00:06:18 +00:00
dhrp f35a9d8098 create README.md at this place for preview. 2017-06-02 00:06:18 +00:00