On 11/03/2011 06:08 PM, Lex Trotman wrote:
On 4 November 2011 11:58, Matthew Brush<[email protected]> wrote:
On 11/03/2011 03:34 PM, Russell Dickenson wrote:
I am currently contibuting to the Geany newsletter, some of which
includes explanations of Geany's features. Some of what I have written
could be used to expand the Geany documentation and I wondering how I
do that? Is it maintained in an existing git repo and if so: which one
and would I be able to be given commit access to it?
Hi Russell,
The manual itself is generated from the doc/geany.txt to make the geany.html
file. You need to clone the geany repository, change into the `doc`
directory and type `make doc` which will re-generate the documentation.
To do it, you need `rst2html` which is in the `python-docutils` on
Debian/Ubuntu/friends. I guess you already know this and how to use
restructured text from the newsletter.
Hi Russel,
Not that I'd ever disagree with Matthew :) ...
But I suggest you only submit changes to the Geany.txt and let the
committer generate the HTML document. That doesn't mean that you
might not want to generate it just to check that it looks ok, but it
is better just to submit the source IMNSHO.
That makes sense.
If you are confident of your ReST you can just do it all in Github,
like I did for the pull request I sent on the newsletter.
For some reason we're committing changes to the generated documentation file
into VCS, though I have some feelings about this :), so your commits should
include the generated geany.html file as well as the geany.txt file (not
sure if other files will change, but I don't think so).
Nothing else should change. Reasons for VCSing the HTML were
"discussed" elsewhere :)
I guess I should search the ML archives to see what's up with that :)
Cheers,
Matthew Brush
_______________________________________________
Geany mailing list
[email protected]
https://lists.uvena.de/cgi-bin/mailman/listinfo/geany
