git.iko.soy/searx
on master help sign in
docs: document Makefile setup and 'buildenv' (aka brand)
4e307edMarkus Heiser
Makefile+2
compare with master
unifiedsplit
@@ -1,10 +1,12 @@
1# -*- coding: utf-8; mode: makefile-gmake -*-
1# -*- coding: utf-8; mode: makefile-gmake -*-
2.DEFAULT_GOAL=help
2.DEFAULT_GOAL=help
3
3
4+# START Makefile setup
4export GIT_URL=https://github.com/asciimoo/searx
5export GIT_URL=https://github.com/asciimoo/searx
5export GIT_BRANCH=master
6export GIT_BRANCH=master
6export SEARX_URL=https://searx.me
7export SEARX_URL=https://searx.me
7export DOCS_URL=https://asciimoo.github.io/searx
8export DOCS_URL=https://asciimoo.github.io/searx
9+# END Makefile setup
8
10
9include utils/makefile.include
11include utils/makefile.include
10
12
docs/dev/makefile.rst+17−22
@@ -18,18 +18,10 @@ With the aim to simplify development cycles, started with :pull:`1756` a
18Makefiles, we recommend to read gnu-make_ introduction.
18Makefiles, we recommend to read gnu-make_ introduction.
19
19
20The usage is simple, just type ``make {target-name}`` to *build* a target.
20The usage is simple, just type ``make {target-name}`` to *build* a target.
21−Calling the ``help`` target gives a first overview::
21+Calling the ``help`` target gives a first overview (``make help``):
22−
22+
23− $ make help
23+.. program-output:: bash -c "cd ..; make --no-print-directory help"
24− test - run developer tests
24+
25− docs - build documentation
26− docs-live - autobuild HTML documentation while editing
27− run - run developer instance
28− install - developer install (./local)
29− uninstall - uninstall (./local)
30− gh-pages - build docs & deploy on gh-pages branch
31− clean - drop builds and environments
32− ...
33
25
34.. contents:: Contents
26.. contents:: Contents
35 :depth: 2
27 :depth: 2
@@ -44,25 +36,28 @@ Makefile setup
44
36
45.. _git stash: https://git-scm.com/docs/git-stash
37.. _git stash: https://git-scm.com/docs/git-stash
46
38
47−The main setup is done in the :origin:`Makefile`::
48−
49− export GIT_URL=https://github.com/asciimoo/searx
50− export GIT_BRANCH=master
51− export SEARX_URL=https://searx.me
52− export DOCS_URL=https://asciimoo.github.io/searx
53−
54.. sidebar:: fork & upstream
39.. sidebar:: fork & upstream
55
40
56 Commit changes in your (local) branch, fork or whatever, but do not push them
41 Commit changes in your (local) branch, fork or whatever, but do not push them
57 upstream / `git stash`_ is your friend.
42 upstream / `git stash`_ is your friend.
58
43
59−:GIT_URL: Changes this, to point to your searx fork.
44+The main setup is done in the :origin:`Makefile`.
45+
46+.. literalinclude:: ../../Makefile
47+ :start-after: START Makefile setup
48+ :end-before: END Makefile setup
60
49
50+:GIT_URL: Changes this, to point to your searx fork.
61:GIT_BRANCH: Changes this, to point to your searx branch.
51:GIT_BRANCH: Changes this, to point to your searx branch.
52+:SEARX_URL: Changes this, to point to your searx instance.
53+:DOCS_URL: If you host your own (*brand*) documentation, change this URL.
62
54
63−:SEARX_URL: Changes this, to point to your searx instance.
55+If you change any of this build environment variables, you have to run ``make
56+buildenv``::
64
57
65−:DOCS_URL: If you host your own (branded) documentation, change this URL.
58+ $ make buildenv
59+ build searx/brand.py
60+ build utils/brand.env
66
61
67.. _make pyenv:
62.. _make pyenv:
68
63