-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #193 from FirelyTeam/devops/docker
devops: Definition of docker image for Sphinx, using our settings.
- Loading branch information
Showing
3 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# in your Dockerfile | ||
FROM sphinxdoc/sphinx | ||
|
||
WORKDIR /docs | ||
ADD requirements.txt /docs | ||
RUN pip3 install -r requirements.txt | ||
|
||
CMD sphinx-build -b html . ./_build/html | ||
|
||
#to build this image (note the dot at the end for the current folder): | ||
#docker build -t firely.azurecr.io/firely/docs-sphinx:latest . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
This dockerfile defines the firely/docs-sphinx image. | ||
Should the firely docs need more dependencies, add them to requirements.txt and rebuild the image. | ||
|
||
`docker build -t firely.azurecr.io/firely/docs-sphinx:latest .` | ||
|
||
Then login to our private container registry on Azure. For login credentials ask Marco or Christiaan. If you have access to our Azure portal already, you can find it yourself. Look for the 'firely' Container Registry, and then its 'Access keys'. | ||
|
||
`docker login firely.azurecr.io` | ||
|
||
Then push the new image: | ||
|
||
`docker push firely.azurecr.io/firely/docs-sphinx:latest` | ||
|
||
To just *use* the image: | ||
|
||
- login to firely.azurecr.io, see above | ||
- pull the image: `docker pull firely.azurecr.io/firely/docs-sphinx` | ||
|
||
At least the `firely-docs-firely-server` repo has a handy Powershell script [build-in-docker.ps1](https://github.com/FirelyTeam/firely-docs-firely-server/blob/master/build-in-docker.ps1) to run the build using this container. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
###### Requirements for firely docs without Version Specifiers ###### | ||
sphinx-rtd-theme |