OwlBurst/Ponysearch
1
0
Fork 0
forked from Ponysearch/Ponysearch
Code Pull requests Activity

docs: document Makefile setup and 'buildenv' (aka brand)

Browse source 
Add documentation of the Makefile environment (aka brand, buildenv), introduced
in PR #1900.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2020-03-30 13:31:13 +02:00
parent e73abd9d8a
commit 4e307edb2d
2 changed files with 18 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -1,10 +1,12 @@
# -*- coding: utf-8; mode: makefile-gmake -*- # -*- coding: utf-8; mode: makefile-gmake -*-
.DEFAULT_GOAL=help .DEFAULT_GOAL=help
# START Makefile setup
export GIT_URL=https://github.com/asciimoo/searx export GIT_URL=https://github.com/asciimoo/searx
export GIT_BRANCH=master export GIT_BRANCH=master
export SEARX_URL=https://searx.me export SEARX_URL=https://searx.me
export DOCS_URL=https://asciimoo.github.io/searx export DOCS_URL=https://asciimoo.github.io/searx
# END Makefile setup
include utils/makefile.include include utils/makefile.include

37
docs/dev/makefile.rst
View file

@ -18,18 +18,10 @@ With the aim to simplify development cycles, started with :pull:`1756` a
Makefiles, we recommend to read gnu-make_ introduction. Makefiles, we recommend to read gnu-make_ introduction.
The usage is simple, just type ``make {target-name}`` to *build* a target. The usage is simple, just type ``make {target-name}`` to *build* a target.
Calling the ``help`` target gives a first overview:: Calling the ``help`` target gives a first overview (``make help``):
.. program-output:: bash -c "cd ..; make --no-print-directory help"
$ 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
...
.. contents:: Contents .. contents:: Contents
:depth: 2 :depth: 2
@ -44,25 +36,28 @@ Makefile setup
.. _git stash: https://git-scm.com/docs/git-stash .. _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 .. sidebar:: fork & upstream
Commit changes in your (local) branch, fork or whatever, but do not push them Commit changes in your (local) branch, fork or whatever, but do not push them
upstream / `git stash`_ is your friend. 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. :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: .. _make pyenv: