Comments (14)
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.
Related Issues (20)
- ttkwidgets.Table error .... according to example code
- Overwritten configure methods don't return values
- AutocompleteCombobox has bug when type very quickly.
- Checkbox Treeview Image Replacing Checkbox HOT 2
- Is it possible to insert image along with ttkwidgets CheckboxTreeview
- Improvement ideas for ttkwidgets HOT 3
- Hooks and validated entries missing from Pypi package HOT 3
- Add screenshots in docs
- Library ttkwidgets==0.12.0 automatically installed under Python 2 HOT 3
- Merging new widgets
- checkboxTreeview: no highlighting row if selected HOT 1
- widgets don't work when using ScrolledFrame.
- Could not resolve import
- About timeline. HOT 1
- [Feature request] Get value range from Scale? HOT 1
- Autocomplete search match with case INSENSITIVE
- askfont - if I select first font type and then the size it don't work. HOT 2
- Change license to GNU LGPL instead of GPL? HOT 1
- Checkbox backgrounds HOT 1
- how to check AutocompleteCombobox is selected for calling a callback function
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ttkwidgets.