diff --git a/docs/Dockerfile b/docs/Dockerfile index e5fd267ebd..d3418ee968 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,11 +1,16 @@ from ubuntu:12.04 maintainer Nick Stinemates +# +# docker build -t docker:docs . && docker run -p 8000:8000 docker:docs +# run apt-get update run apt-get install -y python-setuptools make run easy_install pip +#from docs/requirements.txt, but here to increase cacheability +run pip install Sphinx==1.1.3 +run pip install sphinxcontrib-httpdomain==1.1.8 add . /docs -run pip install -r /docs/requirements.txt run cd /docs; make docs expose 8000 diff --git a/docs/README.md b/docs/README.md index 82103b9c72..63cd8a6ac5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -57,6 +57,9 @@ docs inside the container, even starting a simple HTTP server on port build .`` and run the resulting image. This is the equivalent to ``make clean server`` since each container starts clean. +In the ``docs/`` directory, run: + ```docker build -t docker:docs . && docker run -p 8000:8000 docker:docs``` + Usage ----- * Follow the contribution guidelines (``../CONTRIBUTING.md``) diff --git a/docs/sources/contributing/contributing.rst b/docs/sources/contributing/contributing.rst index 301977e5e1..3cdb0b6f14 100644 --- a/docs/sources/contributing/contributing.rst +++ b/docs/sources/contributing/contributing.rst @@ -5,5 +5,18 @@ Contributing to Docker ====================== -Want to hack on Docker? Awesome! The repository includes `all the instructions you need to get started `_. +Want to hack on Docker? Awesome! +The repository includes `all the instructions you need to get +started `_. + +The developer environment `Dockerfile `_ +specifies the tools and versions used to test and build Docker. + +If you're making changes to the documentation, see the +`README.md `_. + +The documentation environment `Dockerfile `_ +specifies the tools and versions used to build the Documentation. + +Further interesting details can be found in the `Packaging hints `_.