Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #96803 > unrolled thread

Re: Automating build from source (was: Automating Sphinx generated documentation)

Back to article view | Back to comp.lang.python

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  Re: Automating build from source (was: Automating Sphinx generated documentation) Peter Otten <__peter__@web.de> - 2015-09-18 08:50 +0200

#96803 — Re: Automating build from source (was: Automating Sphinx generated documentation)

Ben Finney wrote:

> David Aldrich <David.Aldrich@EMEA.NEC.COM> writes:
> 
>> I have setup Sphinx for my Python project. We keep all our code and
>> documentation in Subversion.
> 
> It's a good idea to keep *source* files in VCS.
> 
> It's a bad idea to keep automatically-generated files in VCS; it's
> especially bad to do so if they need to be generated again after
> changing the source files.
> 
>> So, following changes to the Python code, I need to regenerate and
>> commit the Sphinx generated documentation.
> 
> Instead, the build products – anything generated automatically by the
> computer, such as the compiled code, compiled documentation – should be
> flagged for “ignore” by the VCS, and never committed.
> 
> The VCS should track only those files that humans edit directly.

Isn't this a case of purity versus practicality? I imagine it might be nice 
to get fairly up-to-date documentation along with your source code checkout 
"for free".

[toc] | [standalone]

Back to top | Article view | comp.lang.python

csiph-web