Issue 2550545
Created on 2009-05-07 19:25 by ber, last changed 2016-04-19 06:56 by pefu.
msg3702 |
Author: [hidden] (ber) |
Date: 2009-05-07 19:25 |
|
Version 1.4.8
official tarball
README.txt has
The *.txt files in the "doc" directory are written in
reStructedText. If
you have rst2html installed (part of the docutils suite) you can
convert
these to HTML by running "make html" in the "doc" directory.
There is no makefile in "doc".
python setup.py build_doc
is not mentioned, which needs
roundup/dist/command/build_doc.py
sphinx = find_executable('sphinx-build')
Which is an (optional?) prerequisite which should be mentioned
in installation.txt I guess.
|
msg3728 |
Author: [hidden] (stefan) |
Date: 2009-06-17 14:36 |
|
The current procedure to build documentation is 'python setup.py
build_doc'. Doing this will result in HTML docs put into
share/doc/roundup/html/. Richard, I would suggest to run this prior to
all packaging, such that all source and binary packages contain these
HTML docs. Then, we can adjust the toplevel README.txt to point to those.
If we run the 'build_doc' command prior to any packaging, there is no
need for anybody but us to have sphinx installed (and so it doesn't
become a prerequisite for Roundup users).
Does this make sense ?
|
msg3729 |
Author: [hidden] (ber) |
Date: 2009-06-17 14:42 |
|
I think it is good to build the documentation before packaging.
(I haven't checked the repository, but I think you should directly change
the instructions in the repository for people trying the latest revision.)
|
msg3734 |
Author: [hidden] (richard) |
Date: 2009-06-18 00:10 |
|
Sure, sounds like a good idea to me.
|
msg5537 |
Author: [hidden] (pefu) |
Date: 2016-04-19 06:56 |
|
I believe this has long been fixed in 3dc458554d68 by John Kristensen
on Sun, 16 Dec 2012 13:10:52
|
|
Date |
User |
Action |
Args |
2016-04-19 06:56:38 | pefu | set | status: open -> fixed resolution: fixed messages:
+ msg5537 nosy:
+ pefu |
2010-11-17 21:41:17 | eric.araujo | set | nosy:
+ eric.araujo |
2009-06-18 00:10:31 | richard | set | messages:
+ msg3734 |
2009-06-17 14:42:57 | ber | set | messages:
+ msg3729 |
2009-06-17 14:36:21 | stefan | set | status: new -> open assignee: stefan messages:
+ msg3728 nosy:
+ richard |
2009-05-07 19:25:05 | ber | create | |
|