summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2020-03-30 13:31:13 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2020-03-30 13:31:13 +0200
commit4e307edb2d3e5a726d78d73dea1ebe4b9d831615 (patch)
tree50a5743ceeb767bc12fe878d5ada6e4a2dfe6cfe /docs/dev
parente73abd9d8a633d86f753cae25d620ddaf2243a14 (diff)
downloadsearxng-4e307edb2d3e5a726d78d73dea1ebe4b9d831615.tar.gz
searxng-4e307edb2d3e5a726d78d73dea1ebe4b9d831615.zip
docs: document Makefile setup and 'buildenv' (aka brand)
Add documentation of the Makefile environment (aka brand, buildenv), introduced in PR #1900. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/makefile.rst39
1 files changed, 17 insertions, 22 deletions
diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst
index fc0b4639c..62cd0a984 100644
--- a/docs/dev/makefile.rst
+++ b/docs/dev/makefile.rst
@@ -18,18 +18,10 @@ With the aim to simplify development cycles, started with :pull:`1756` a
Makefiles, we recommend to read gnu-make_ introduction.
The usage is simple, just type ``make {target-name}`` to *build* a target.
-Calling the ``help`` target gives a first overview::
-
- $ make help
- test - run developer tests
- docs - build documentation
- docs-live - autobuild HTML documentation while editing
- run - run developer instance
- install - developer install (./local)
- uninstall - uninstall (./local)
- gh-pages - build docs & deploy on gh-pages branch
- clean - drop builds and environments
- ...
+Calling the ``help`` target gives a first overview (``make help``):
+
+.. program-output:: bash -c "cd ..; make --no-print-directory help"
+
.. contents:: Contents
:depth: 2
@@ -44,25 +36,28 @@ Makefile setup
.. _git stash: https://git-scm.com/docs/git-stash
-The main setup is done in the :origin:`Makefile`::
-
- export GIT_URL=https://github.com/asciimoo/searx
- export GIT_BRANCH=master
- export SEARX_URL=https://searx.me
- export DOCS_URL=https://asciimoo.github.io/searx
-
.. sidebar:: fork & upstream
Commit changes in your (local) branch, fork or whatever, but do not push them
upstream / `git stash`_ is your friend.
-:GIT_URL: Changes this, to point to your searx fork.
+The main setup is done in the :origin:`Makefile`.
+
+.. literalinclude:: ../../Makefile
+ :start-after: START Makefile setup
+ :end-before: END Makefile setup
+:GIT_URL: Changes this, to point to your searx fork.
:GIT_BRANCH: Changes this, to point to your searx branch.
+:SEARX_URL: Changes this, to point to your searx instance.
+:DOCS_URL: If you host your own (*brand*) documentation, change this URL.
-:SEARX_URL: Changes this, to point to your searx instance.
+If you change any of this build environment variables, you have to run ``make
+buildenv``::
-:DOCS_URL: If you host your own (branded) documentation, change this URL.
+ $ make buildenv
+ build searx/brand.py
+ build utils/brand.env
.. _make pyenv: