Wiki R/O
anatoly techtonik
with SPAM that urged to close them? Or maybe the docs are
automatically generated and can not be edited?
I am asking because some content can be improved. For example, meaning
of various fields of configuration add form (for which some tooltips
would look nice). Configuration link can be placed over recipes etc.
--
anatoly t.
Simon Cross
> Most wiki pages are R/O unlike t.e.o. site. Is there a big problem
> with SPAM that urged to close them? Or maybe the docs are
> automatically generated and can not be edited?
The docs are automatically read from the documentation files in the
svn repository. I don't know whether the t.e.o would want to change
this or whether the one way is better than the other but it's the way
it is for now.
> I am asking because some content can be improved. For example, meaning
> of various fields of configuration add form (for which some tooltips
> would look nice). Configuration link can be placed over recipes etc.
If you're really keen to help document submitting documentation
patches is a good place to start, I guess.
Schiavo
Simon
anatoly techtonik
Yes, but it would be nice to have some guidance to avoid losing time,
like markers on the page that content is displayed from SVN
repository. And Edit button would popup page with proper instructions
how to create patches and test them. Or provide online editor for the
content that saves edits as patches into patch queue for this page.
I do not remember that I wanted to fix in the first place and do not
have the time to setup development environment to check my patches. Do
you know the latest trend in setting up such environments for
development in Python? http://trac.edgewall.org/wiki/TracDev/DevelopmentEnvironmentSetup
contains some information specific to patches for Python packages
(setup.py develop), but it is buried under other stuff.
--
anatoly t.
osimons
> On Feb 26, 8:38 pm, Simon Cross <hodges...@gmail.com> wrote:
> I do not remember that I wanted to fix in the first place and do not
> have the time to setup development environment to check my patches. Do
> you know the latest trend in setting up such environments for
> contains some information specific to patches for Python packages
> (setup.py develop), but it is buried under other stuff.
>
> --
> anatoly t.
Here is the essence of how to get docs building:
1) Install docutils (usually installed by Trac development setup
anyway)
2) Install epydoc
3) Subversion checkout of Biiten source
4) Run: python setup.py build_doc
5) Open doc/index.html in a browser and verify result
This list is made from memory of what I did 10 months ago when I got
it working, so it needs to be verified... After that we should perhaps
put a quick intro somewhere in the wiki, and I've already started a
similar BittenDev/ section (although it just contains one page so
far). Perhaps make a BittenDev/BuildDocs page?
:::simon
https://www.coderesort.com
http://www.ohloh.net/accounts/osimons
anatoly techtonik
>
> Here is the essence of how to get docs building:
>
> 1) Install docutils (usually installed by Trac development setup
> anyway)
> 2) Install epydoc
> 3) Subversion checkout of Biiten source
> 4) Run: python setup.py build_doc
> 5) Open doc/index.html in a browser and verify result
>
> This list is made from memory of what I did 10 months ago when I got
> it working, so it needs to be verified... After that we should perhaps
> put a quick intro somewhere in the wiki, and I've already started a
> similar BittenDev/ section (although it just contains one page so
> far). Perhaps make a BittenDev/BuildDocs page?
I couldn't find where BittenDev is linked from. Seems like front page
is the best place for the link.
Is it possible to add BittenDev/DocsDev link for people who try to
edit pages mured in reST?
The best would be that the link appears after user clicks "Edit Page"
button. Which plugin is used?
--
anatoly t.
osimons
> On Thu, Apr 1, 2010 at 12:12 AM, osimons <oddsim...@gmail.com> wrote:
>
> > Here is the essence of how to get docs building:
>
> > 1) Install docutils (usually installed by Trac development setup
> > anyway)
> > 2) Install epydoc
> > 3) Subversion checkout of Biiten source
> > 4) Run: python setup.py build_doc
> > 5) Open doc/index.html in a browser and verify result
>
> > This list is made from memory of what I did 10 months ago when I got
> > it working, so it needs to be verified... After that we should perhaps
> > put a quick intro somewhere in the wiki, and I've already started a
> > similar BittenDev/ section (although it just contains one page so
> > far). Perhaps make a BittenDev/BuildDocs page?
>
> I couldn't find where BittenDev is linked from. Seems like front page
> is the best place for the link.
TitleIndex :-)
> Is it possible to add BittenDev/DocsDev link for people who try to
> edit pages mured in reST?
> The best would be that the link appears after user clicks "Edit Page"
> button. Which plugin is used?
It is a simple [[Include]] macro that pulls it straight from repos and
renders the rst format. Use the 'alternative formats' link to see the
text, like:
http://bitten.edgewall.org/wiki/Documentation/install.html?format=txt
Which looks like this:
[[Title(Installation)]]
[[Include(trunk/doc/install.txt)]]
----
See also: [wiki:Documentation]
=> It isn't any problem adding more information at the end linking to
a howto for changing/patching docs and submitting.
:::simon