IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update installation

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-02-29 16:22:55 +09:00
parent 61b8edcb49
commit e6f8ed063c
1 changed files with 8 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/usage/installation.rst
View File

@ -176,34 +176,20 @@ Please choose one for your purpose.
sphinxdoc/sphinx-latexpdf contains TeXLive packages. So the image is very large (over 2GB!).
.. todo:: The description after this line is not about "installation". So it might be better to move other place.
.. hint::
You can create a Sphinx project::
When using docker images, please use ``docker run`` command to invoke sphinx commands. For example,
you can use following command to create a Sphinx project::
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-quickstart
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-quickstart
You can build HTML document::
And you can following command this to build HTML document::
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx make html
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx make html
You can build EPUB document::
For more details, please read `README file`__ of docker images.
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx make epub
You can build PDF document::
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx-latexpdf make latexpdf
If you would like to install dependencies, use sphinxdoc/sphinx as a base image
.. code-block:: docker
# in your Dockerfile
FROM sphinxdoc/sphinx
WORKDIR /docs
ADD requirements.txt /docs
RUN pip3 install -r requirements.txt
.. __: https://hub.docker.com/repository/docker/sphinxdoc/sphinx
Installation from source