From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Charles C. Berry" Subject: Re: Include sections of org document in tangled files Date: Sat, 3 Dec 2016 10:16:29 -0800 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:34219) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cDErU-0007EU-Ju for emacs-orgmode@gnu.org; Sat, 03 Dec 2016 13:16:37 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cDErR-0002fs-Dw for emacs-orgmode@gnu.org; Sat, 03 Dec 2016 13:16:36 -0500 Received: from iport-acv3-out.ucsd.edu ([132.239.0.4]:44629) by eggs.gnu.org with esmtps (TLS1.0:RSA_ARCFOUR_SHA1:16) (Exim 4.71) (envelope-from ) id 1cDErR-0002db-03 for emacs-orgmode@gnu.org; Sat, 03 Dec 2016 13:16:33 -0500 In-Reply-To: List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: David Dynerman Cc: David Dynerman , emacs-orgmode@gnu.org On Fri, 2 Dec 2016, David Dynerman wrote: > Dear list, > > Is it possible to include sections of an org document while tangling. > > I have in mind something like the following: > > * Some section [David's version deleted] #+NAME: doc #+BEGIN_SRC org :exports results :results replace This is an introduction. We're going to write some code that implements (a finite version of) the formula \[ f(x) = 1 + x + \frac{x^2}{2} + \frac{x^3}{6} + \ldots + \frac{x^n}{n!} + \ldots \] Here's some background about the exponential function. #+END_SRC #+header: :noweb (unless org-export-current-backend "yes") #+BEGIN_SRC python :tangle myfunction.py from math import factorial def f(x,n): """ <> """ y = 0 for i in range(n+1): y = y + x**i/factorial(i) return y #+END_SRC > The idea would be that when I export this to HTML, I get a nice literate > programming math jax'd section introduction that explains what the > function is doing. Right. The above does that. You need `org' as a babel language. Eval'ing `(require 'ob-org)' is good enough for just trying to export this, but customizing `org-babel-load-languages' to include `org' is better if you use this regularly. > Then, when I tangle to generate the python file, the > org section introduction would be included as the python docstring of > the function. > And it does that. --- There is an issue you might want to address if you use this approach. First, the first triple quotes must not be on the same line as the included src block reference. That is because """>""" will prepend the quotes to every line in `src-blk-ref'. If you do not want the newlines between the quotes and the docstring, I think there is a post-tangle hook you can use to clean the tangled version by removing those newlines. Also, you can use an export filter to remove the quotes and the noweb reference for a cleaner looking exported doc. Note that you need to use a unique name for each src-block. HTH, Chuck