Skip to content

Commit

Permalink
Continue to add content.
Browse files Browse the repository at this point in the history
Signed-off-by: Volker Theile <volker.theile@openmediavault.org>
  • Loading branch information
votdev committed Jan 16, 2018
1 parent 486ee30 commit c7304f4
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 12 deletions.
22 changes: 18 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,32 @@ SPHINXBUILD = sphinx-build
SPHINXPROJ = openmediavault-wiki
SOURCEDIR = .
BUILDDIR = _build
VENVDIR = venv

# Helper targets to create the isolated Python environment.
venv:
( \
virtualenv -p python3 $(VENVDIR); \
. $(VENVDIR)/bin/activate; \
pip install -r requirements.txt; \
)

buildvenv: venv

autobuild: venv
( \
. $(VENVDIR)/bin/activate; \
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)/html" \
)

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

autobuild:
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)/html"

clean:
rm -rf "$(BUILDDIR)"

.PHONY: autobuild clean help Makefile
.PHONY: autobuild buildvenv clean 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).
Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,15 @@ can do this the following way:
To initially setup the virtual Python environment simply execute the following
lines:

$ virtualenv -p python3 venv
$ cd venv
$ source bin/activate
$ pip install -r ../requirements.txt
$ make buildvenv

Build the HTML code
-------------------

$ cd venv
$ source bin/activate
$ cd .. && make autobuild
$ make autobuild

Now open <http://localhost:8000/> in your browser to view the Wiki page.
Now open <http://localhost:8000/> in your browser to view the Wiki page. Any
changes to the documentation code will be rendered now immediatelly.

Cleanup the generated HTML
--------------------------
Expand Down

0 comments on commit c7304f4

Please sign in to comment.