2d95669 · searx · git.iko.soy

Makefile+13−4

compare with master

unifiedsplit

@@ -12,8 +12,13 @@ include utils/makefile.sphinx

12

13all: clean install

14

15−PHONY += help

15+PHONY += help-min help-all help

16+

16−help:

17+help: help-min

18+ @echo ''

19+ @echo 'to get more help: make help-all'

20+

21+help-min:

17 @echo ' test - run developer tests'

22 @echo ' test - run developer tests'

18 @echo ' docs - build documentation'

23 @echo ' docs - build documentation'

19 @echo ' docs-live - autobuild HTML documentation while editing'

24 @echo ' docs-live - autobuild HTML documentation while editing'

@@ -29,9 +34,13 @@ help:

29 @echo ' GIT_URL = $(GIT_URL)'

34 @echo ' GIT_URL = $(GIT_URL)'

30 @echo ' DOCS_URL = $(DOCS_URL)'

35 @echo ' DOCS_URL = $(DOCS_URL)'

31 @echo ''

36 @echo ''

32− @$(MAKE) -e -s -f utils/makefile.include make-help

37+ @$(MAKE) -e -s make-help

38+

39+help-all: help-min

40+ @echo ''

41+ @$(MAKE) -e -s python-help

33 @echo ''

42 @echo ''

34− @$(MAKE) -e -s -f utils/makefile.python python-help

43+ @$(MAKE) -e -s docs-help

35

44

36PHONY += install

45PHONY += install

37install: pyenvinstall

46install: pyenvinstall

docs/conf.py+7

@@ -1,6 +1,7 @@

1# -*- coding: utf-8 -*-

2

3import sys, os

4+from sphinx_build_tools import load_sphinx_config

4from searx.version import VERSION_STRING

5from searx.version import VERSION_STRING

5from pallets_sphinx_themes import ProjectLink

6from pallets_sphinx_themes import ProjectLink

6

7

@@ -116,3 +117,9 @@ html_show_sourcelink = False

116latex_documents = [

117latex_documents = [

117 (master_doc, "searx-{}.tex".format(VERSION_STRING), html_title, author, "manual")

118 (master_doc, "searx-{}.tex".format(VERSION_STRING), html_title, author, "manual")

118]

119]

120+

121+# ------------------------------------------------------------------------------

122+# Since loadConfig overwrites settings from the global namespace, it has to be

123+# the last statement in the conf.py file

124+# ------------------------------------------------------------------------------

125+load_sphinx_config(globals())

docs/user/conf.pynew file+19

@@ -0,0 +1,19 @@

1+# -*- coding: utf-8; mode: python -*-

2+"""Configuration for the CDB 15 Infrastruktur book

3+"""

4+project = 'Searx User-HB'

5+version = release = VERSION_STRING

6+

7+# Grouping the document tree into LaTeX files. List of tuples

8+# (source start file, target name, title,

9+# author, documentclass [howto, manual, or own class]).

10+latex_documents = [

11+ ('index' # startdocname

12+ , 'searx-user-hb.tex' # targetname

13+ , '' # take title from .rst

14+ , author # author

15+ , 'howto' # documentclass

16+ , False # toctree_only

17+ ),

18+]

19+

utils/makefile.sphinx+3−3

@@ -156,7 +156,7 @@ $(BOOKS_HTML): sphinx-doc | $(BOOKS_DIST)

156 -b html \

157 -c $(DOCS_FOLDER) \

158 -d $(DOCS_BUILD)/books/$(patsubst books/%.html,%,$@)/.doctrees \

159− $(patsubst books/%.html,%,$@) \

159+ $(BOOKS_FOLDER)/$(patsubst books/%.html,%,$@) \

160 $(BOOKS_DIST)/$(patsubst books/%.html,%,$@)

161 @echo "SPHINX $@ --> file://$(abspath $(BOOKS_DIST)/$(patsubst books/%.html,%,$@))"

162

@@ -168,7 +168,7 @@ $(BOOKS_LIVE): sphinx-live | $(BOOKS_DIST)

168 -b html \

169 -c $(DOCS_FOLDER) \

170 -d $(DOCS_BUILD)/books/$(patsubst books/%.live,%,$@)/.doctrees \

171− $(patsubst books/%.live,%,$@) \

171+ $(BOOKS_FOLDER)/$(patsubst books/%.live,%,$@) \

172 $(BOOKS_DIST)/$(patsubst books/%.live,%,$@)

173

174$(BOOKS_PDF): %.pdf : %.latex

@@ -184,7 +184,7 @@ $(BOOKS_LATEX): sphinx-doc | $(BOOKS_DIST)

184 -b latex \

185 -c $(DOCS_FOLDER) \

186 -d $(DOCS_BUILD)/books/$(patsubst books/%.latex,%,$@)/.doctrees \

187− $(patsubst books/%.latex,%,$@) \

187+ $(BOOKS_FOLDER)/$(patsubst books/%.latex,%,$@) \

188 $(DOCS_BUILD)/latex/$(patsubst books/%.latex,%,$@)

189 @echo "SPHINX $@ --> file://$(abspath $(DOCS_BUILD)/latex/$(patsubst books/%.latex,%,$@))"

190

utils/site-python/sphinx_build_tools.pynew file+48

@@ -0,0 +1,48 @@

1+# -*- coding: utf-8; mode: python -*-

2+"""Implement some sphinx-build tools.

3+

4+"""

5+

6+import os

7+import sys

8+from sphinx.util.pycompat import execfile_

9+

10+# ------------------------------------------------------------------------------

11+def load_sphinx_config(namespace):

12+# ------------------------------------------------------------------------------

13+

14+ u"""Load an additional configuration file into *namespace*.

15+

16+ The name of the configuration file is taken from the environment

17+ ``SPHINX_CONF``. The external configuration file extends (or overwrites) the

18+ configuration values from the origin ``conf.py``. With this you are able to

19+ maintain *build themes*. To your docs/conf.py add::

20+

21+ from sphinx_build_tools import load_sphinx_config

22+ ...

23+

24+ # Since loadConfig overwrites settings from the global namespace, it has to be

25+ # the last statement in the conf.py file

26+

27+ load_sphinx_config(globals())

28+

29+ """

30+

31+ config_file = os.environ.get("SPHINX_CONF", None)

32+ if (config_file is not None

33+ and os.path.normpath(namespace["__file__"]) != os.path.normpath(config_file) ):

34+ config_file = os.path.abspath(config_file)

35+

36+ if os.path.isfile(config_file):

37+ sys.stdout.write(

38+ "load additional sphinx-config: %s\n"

39+ % config_file)

40+ config = namespace.copy()

41+ config['__file__'] = config_file

42+ execfile_(config_file, config)

43+ del config['__file__']

44+ namespace.update(config)

45+ else:

46+ sys.stderr.write(

47+ "WARNING: additional sphinx-config not found: %s\n"

48+ % config_file)