From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Cc: flub@devork.be, David Bremner <david@tethera.net>
Subject: [PATCH 1/2] doc: replace use of environment variables with a generated config
Date: Sat, 11 Jul 2020 10:20:26 -0300 [thread overview]
Message-ID: <20200711132027.1449094-1-david@tethera.net> (raw)
I don't love the use of exec, but it is getting unwieldy to pass
configuration options on the sphinx-build command line, and I
anticipate further use of conditionals.
---
configure | 8 ++++++++
doc/Makefile.local | 2 +-
doc/conf.py | 11 ++++++++---
3 files changed, 17 insertions(+), 4 deletions(-)
diff --git a/configure b/configure
index 80cbac4f..177432db 100755
--- a/configure
+++ b/configure
@@ -1548,6 +1548,14 @@ NOTMUCH_HAVE_PYTHON3_PYTEST=${have_python3_pytest}
PLATFORM=${platform}
EOF
+cat > sphinx.config <<EOF
+# Generate 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.
cat <<EOF
diff --git a/doc/Makefile.local b/doc/Makefile.local
index 769438ed..598b6028 100644
--- a/doc/Makefile.local
+++ b/doc/Makefile.local
@@ -4,7 +4,7 @@ dir := doc
# You can set these variables from the command line.
SPHINXOPTS := -q
-SPHINXBUILD = WITH_EMACS=${WITH_EMACS} RSTI_DIR=$(realpath emacs) sphinx-build
+SPHINXBUILD = sphinx-build
DOCBUILDDIR := $(dir)/_build
# Internal variables.
diff --git a/doc/conf.py b/doc/conf.py
index 70987ac5..fdff2a2c 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -22,6 +22,13 @@ for pathdir in ['.', '..']:
with open(version_file,'r') as infile:
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.
release = version
@@ -29,12 +36,10 @@ release = version
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
-if os.environ.get('WITH_EMACS') == '1':
+if tags.has('WITH_EMACS'):
# Hacky reimplementation of include to workaround limitations of
# sphinx-doc
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'):
lines.extend(open(rsti_dir+'/'+file))
rst_epilog = ''.join(lines)
--
2.27.0
next reply other threads:[~2020-07-11 13:20 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-11 13:20 David Bremner [this message]
2020-07-11 13:20 ` [PATCH 2/2] doc: add new python bindings to main documentatation tree David Bremner
2020-07-12 12:02 ` [PATCH] doc: set up for autoapi / readthedocs compatibility David Bremner
2020-07-14 21:42 ` Floris Bruynooghe
2020-07-15 11:53 ` David Bremner
2020-07-14 21:21 ` [PATCH 2/2] doc: add new python bindings to main documentatation tree Floris Bruynooghe
2020-07-11 14:00 ` [PATCH 1/2] doc: replace use of environment variables with a generated config Tomi Ollila
2020-07-14 21:43 ` Floris Bruynooghe
2020-07-15 12:28 ` David Bremner
2020-07-15 12:36 ` [PATCH] configure: replace multiple redirects with redirected block David Bremner
2020-07-18 15:00 ` David Bremner
2020-07-14 21:15 ` [PATCH 1/2] doc: replace use of environment variables with a generated config Floris Bruynooghe
2020-07-17 10:07 ` Tomi Ollila
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200711132027.1449094-1-david@tethera.net \
--to=david@tethera.net \
--cc=flub@devork.be \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).