Documentation on "Generation of trees" is incomplete

[maxale]

Steps To Reproduce

There exist at least 3 methods of trees generation in Sage:

• via sage.graphs.trees.TreeIterator()
• via graphs.trees()
• via graphs.nauty_gentreeg()

Expected Behavior

Documentation at https://doc.sagemath.org/html/en/reference/graphs/sage/graphs/trees.html should mention all available methods, and possibly explain differences between them.

Actual Behavior

Only the first method is described.

Additional Information

No response

Environment

• OS: N/A
• Sage Version: 10.6.beta1

Checklist

• I have searched the existing issues for a bug report that matches the one I want to file, without success.
• I have read the documentation and troubleshoot guide

[PrashantChoudhary13579]

Hello sir,
Please assign this task to me as i want to do something for this organisation.

[DaveWitteMorris]

See "Various families of graphs" for the documentation of graphs.nauty_gentreeg and graphs.trees. It does seem like a good idea to mention these under "Generation of trees"

[PrashantChoudhary13579]

OK sir,
Thank you sir for providing the information. I will go through them.

[DaveWitteMorris]

PS I think you should be able to assign yourself to this task. Are you unable to do that from some reason? (Also, being assigned to a task is not required in order to work on it. However, it's a good idea because it can avoid wasted effort by dissuading anyone else from working on it at the same time.)

[maxale]

It does seem like a good idea to mention these under "Generation of trees"

I consider "Generation of trees" as an entry point to the subject, and this is where anyone searching for how to generate trees in Sage will likely end up. So, either it should be comprehensive about various ways of generating trees in Sage, or should be renamed to something more specific like "Generation of trees with TreeIterator" or alike. I like the former option better.

[PrashantChoudhary13579]

Sir, I have written the documentation of Various ways of generating trees accordingly in the file trees.pyx but i want to review how it reflects on the webpage.
Please suggest me how can i do this as i am beginner in this organisation.

[DaveWitteMorris]

Compile the sagemath source code (with your changes). I am not an expert on this, but instructions can be found at Install from Source Code and elsewhere on the sagemath web site. (The basic sequence is make configure, ./configure, make.) This should build all of the documentation, so you can see the revised web pages.

[PrashantChoudhary13579]

Thanks for the information it is really helpful and I am exploring and getting the things to be done with my full efforts but while applying the make command, it is showing some error. But trying to solve as soon as possible.

[PredictiveManish]

Doesn't there have any docs repo for all documentation changes?? @PrashantChoudhary13579

[DaveWitteMorris]

I"m sorry, but I do not understand your question. I don't know what "docs repo for all documentation changes" means. I don't think there is a place that lists all changes to the documentation, if that's what you mean.

[PredictiveManish]

I"m sorry, but I do not understand your question. I don't know what "docs repo for all documentation changes" means. I don't think there is a place that lists all changes to the documentation, if that's what you mean.

I found my answer actually I was finding the documentation repo for sagemath thought it would be in any folder and then went back to the org all repos there I found the documentation repo.
No no i was not asking for documentation for all changes. I was asking for documentation of sagemath. Found it
Thanks and sorry for confusion.