Skip to content

Commit

Permalink
Merge pull request #6 from boxbilling/fix/build
Browse files Browse the repository at this point in the history
Docker build
  • Loading branch information
fordnox committed Oct 31, 2020
2 parents a3cc948 + d93a9c5 commit 91a463c
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 10 deletions.
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

12 changes: 12 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
services:
- docker

before_script:
- docker version

script:
- docker build --tag "boxbilling-docs:latest" -f Dockerfile .

after_script:
- docker images

11 changes: 11 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
FROM sphinxdoc/sphinx

WORKDIR .
ADD Makefile .
ADD requirements.txt .
ADD en/ en/
RUN python3 -m pip install --no-cache-dir -U pip
RUN pip3 install -r requirements.txt
RUN ls -la
RUN ls -la en
RUN make html
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = en
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,13 @@
## Welcome

This is the repository for the BoxBilling documentation. Our documentation is
hosted on Read The Docs (http://www.readthedocs.org) which is automatically
hosted on [Read The Docs](https://readthedocs.org) which is automatically
updated when any changes are made to this repository.

You are welcome to fork this repository and add, correct, enhance the
documentation yourselves.
You are welcome to fork this repository and add, correct, enhance the documentation.

The documentation language is reStructuredText (https://www.sphinx-doc.org/en/master/)
The documentation language is [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)

## Build local version of docs

pip3 install -U sphinx
pip3 install sphinx_rtd_theme
sphinx-build -b html en target
docker build --tag boxbilling-docs:1.0 .
Empty file added en/_static/.gitkeep
Empty file.
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx_rtd_theme

0 comments on commit 91a463c

Please sign in to comment.