debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-24 20:08:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: replace use of environment variables with a generated config

Browse source 
It is getting unwieldy to pass configuration options on the
sphinx-build command line, and I anticipate further use of
conditionals.

As far as I could tell, execing a string is the idiomatic way to
emulate include in Python.
This commit is contained in:
David Bremner 2020-07-11 10:20:26 -03:00
parent 78e9b3467d
commit 0e03e2d45e
3 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
configure vendored
View file

@ -1548,6 +1548,14 @@ NOTMUCH_HAVE_PYTHON3_PYTEST=${have_python3_pytest}
PLATFORM=${platform} PLATFORM=${platform}
EOF EOF
cat > sphinx.config <<EOF
# Generated by configure, run from doc/conf.py
EOF
if [ $WITH_EMACS = "1" ]; then
printf "tags.add('WITH_EMACS')\n" >> sphinx.config
fi
printf "rsti_dir = '%s'\n" $(realpath emacs) >> sphinx.config
# Finally, after everything configured, inform the user how to continue. # Finally, after everything configured, inform the user how to continue.
cat <<EOF cat <<EOF

2
doc/Makefile.local
View file

@ -4,7 +4,7 @@ dir := doc
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS := -q SPHINXOPTS := -q
SPHINXBUILD = WITH_EMACS=${WITH_EMACS} RSTI_DIR=$(realpath emacs) sphinx-build SPHINXBUILD = sphinx-build
DOCBUILDDIR := $(dir)/_build DOCBUILDDIR := $(dir)/_build
# Internal variables. # Internal variables.

11
doc/conf.py
View file

@ -22,6 +22,13 @@ for pathdir in ['.', '..']:
with open(version_file,'r') as infile: with open(version_file,'r') as infile:
version=infile.read().replace('\n','') version=infile.read().replace('\n','')
# read generated config
for pathdir in ['.', '..']:
conf_file = os.path.join(location,pathdir,'sphinx.config')
if os.path.exists(conf_file):
with open(conf_file,'r') as infile:
exec(''.join(infile.readlines()))
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = version release = version
@ -29,12 +36,10 @@ release = version
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ['_build'] exclude_patterns = ['_build']
if os.environ.get('WITH_EMACS') == '1': if tags.has('WITH_EMACS'):
# Hacky reimplementation of include to workaround limitations of # Hacky reimplementation of include to workaround limitations of
# sphinx-doc # sphinx-doc
lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
rsti_dir = os.environ.get('RSTI_DIR')
# the other files are from the build tree
for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti'): for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti'):
lines.extend(open(rsti_dir+'/'+file)) lines.extend(open(rsti_dir+'/'+file))
rst_epilog = ''.join(lines) rst_epilog = ''.join(lines)