Documentation migration to ReadTheDocs about ttkwidgets HOT 14 CLOSED

The documentation on sphinx_doc builds just fine on ReadTheDocs, so it is definitely my environment where it is going wrong. It currently looks like this.

from ttkwidgets.

Maybe we can add the examples in a dedicated section?

from ttkwidgets.

That is a great idea. I'm not sure whether such files can be created by sphinx by itself? Otherwise I could write a small script that formats the examples the proper way.

from ttkwidgets.

As far as I know sphinx cannot generates these files automatically so writing a script seems the best option.

from ttkwidgets.

What do you think about the current implementation?

from ttkwidgets.

I think the current implementation is good, sphinx was just complaining about one misplaced newline in examples.rst so I corrected the script.

I also reduced the toctree depth to 1 on the home page because Examples was the only section with displayed subsections.

from ttkwidgets.

@RedFantom This is not directly related to the documentation, but reading the Installation section made me think about it: If you agree I can make a .deb package for ttkwidgets and make it available in a ppa on my launchpad account.

from ttkwidgets.

Oh, sure! I really wouldn't know how to do that or how to maintain that, but it does sound like it could be useful to some users.

What format would you like for the docstrings? I can try to help out over the next few days, but I'm not sure how much time I will have.

from ttkwidgets.

Ok great. I think we should use the standard sphinx formatting (https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html). Some of the modules already use it, like in linklabel.py.

from ttkwidgets.

I have changed a bit the Examples section (63be42b) so that the TOC is split into subpackages like the documentation. I find it clearer that way (especially once there will be one example per widget).

@RedFantom I plan to write the missing examples, do you prefer me to commit them in this branch or in a separate one?

from ttkwidgets.

I suppose a separate branch would be appropriate.

Thanks for the tips on the TimeLine docstrings! I will get to them as soon as I can.

from ttkwidgets.

@j4321 It's been a while, and I've been busy, but I think the documentation is complete now, right? At least, every widget has a documentation entry and it looks good. Do you agree that it is ready for a PR?

from ttkwidgets.

@RedFantom I agree, I was thinking about opening a PR but got caught up with other things.

from ttkwidgets.

The branch sphinx_doc has been merged, and the documentation was built successfully. Thank you so, so much for all your hard work on this, @j4321 !

from ttkwidgets.