Ondrej Certik wrote:

Hi,

I would like to rise the quesiton of documentation again, because I find it really confusing. 4 months ago I created

http://scipy.org/DocumentationNew

That is intended as a replacement for http://scipy.org/Documentation. It should probably be updated to reflect the current state of the documentation.

Also a question to Dmitrey - is there some place with a documentation to your new module? I believe it could go to this page:

http://scipy.org/SciPy_packages

Currently the situation is: Matthieu created the page https://projects.scipy.org/scipy/scikits/wiki/Optimization title for the page is The openopt scikit ¶ <https://projects.scipy.org/scipy/scikits/wiki/Optimization#Theopenoptscikit> Constrained and unconstrained optimization ¶ <https://projects.scipy.org/scipy/scikits/wiki/Optimization#Constrainedandunc...> Framework for generic optimizers (so web search "python openopt" points to the page). but the web page(s) are 100% related to his module "optimizers". The module is part of openopt svn, also, in future, openopt will use some solvers from "optimizers" (i.e. they will be available soon (I hope) with openopt syntax, that's not implemented yet because of lack of time before GSoC finish), on the other hand, "optimizers" remain being a separate module. I didn't created webpages yet, can anyone give me url what should I do? All I need is extracting docstring from each function (MILP, LP, QP, NLP, NSP) from http://projects.scipy.org/scipy/scikits/browser/trunk/openopt/scikits/openop... and attaching examples from http://projects.scipy.org/scipy/scikits/browser/trunk/openopt/scikits/openop... milp_1.py, lp_1.py, qp_1.py, nlp_1.py, nsp_1.py I don't want just copy-paste, because it will be changed (updated) from time to time. Is it possible somehow that webpages changed along with svn code automatically? BTW http://scipy.org/ homepage is missing link to the "scipy packages" page. Don't you think it should be added? Regards, D.

Note: I myself also only put the documentation to the nonlin module inside the code. Once we agree on some way of documenting things, I'll update the documentation on the wiki.

Ondrej _______________________________________________ Scipy-dev mailing list Scipy-dev@scipy.org http://projects.scipy.org/mailman/listinfo/scipy-dev

On 8/22/07, Ondrej Certik <ondrej@certik.cz> wrote:

I would like to rise the quesiton of documentation again, because I find it really confusing. 4 months ago I created

http://scipy.org/DocumentationNew

That is intended as a replacement for http://scipy.org/Documentation. It should probably be updated to reflect the current state of the documentation.

Hey Ondrej, I like the direction you are going with the Documentation page. I completely agree that we need to move toward simplification and streamlining the documentation. Please go ahead, update it, and make your new Documentation page the official one. I added a TOC to the page, which doesn't look particularly attractive. It would be great if you could tidy up what I did. If you are willing to do it, I would like to ask you to become the official maintainer of this page. I think that this page should be aimed at the new user. This means that when someone comes to it for the first time they shouldn't be overwhelmed with information. It should also be easy to find everything you need. Obviously, this trade-off will involve careful consideration. Thanks, -- Jarrod Millman Computational Infrastructure for Research Labs 10 Giannini Hall, UC Berkeley phone: 510.643.4014 http://cirl.berkeley.edu/