[docs] Improve documentation for fontTools.ttLib.ttFont #2442
Conversation
simoncozens
commented
Nov 8, 2021
simoncozens
commented
- Allow cross-references in docs
- Point users more clearly to ttFont
- Remove old example
- Typos
- Improve documentation for ttFont module
|
It looks like the RTD configuration now supports builds on PR's. Helpful to review doc updates in a Sphinx rendered format? |
|
I'd strongly recommend whoever has admin access to RTD (@anthrotype?) to enable this. ( https://docs.readthedocs.io/en/stable/pull-requests.html ) My next documentation PR is going to be significant. |
|
I just enabled that, hope it works. Thanks Simon, I'll take a look soon |
|
@anthrotype I'm interested in the RTD deploy on PR thing, how do I enable it on the designspace PR #2436? |
|
Honestly I have no idea, I simply followed the above linked instructions to enable the feature. I never used RTD myself |
|
Do you have admin access on the repo in RTD Jany? If you do I can show you where to flip the switch. It will show up as a new build line item in the GH CI with a link to the PR specific doc build on RTD. If you activate it on an existing PR it should show up with the next branch commit. |
|
As I said, I have already flipped that switch. Maybe it'll only show up on new PRs |
|
apologies, read this on my phone and was under the assumption that this was for a different repo. |
|
It doesn’t seem to be working - didn’t show up on #2446 which was created after the config change. |
|
Webhook does not seem to be working for some reason. There must be a RTD configuration issue on the fonttools settings side. You might need to approve the RTD OAuth app. @anthrotype I am getting this information on https://readthedocs.org/dashboard/fonttools/integrations/118984/
and I don't have access to modify webhooks here. |
|
I went to that page and clicked Resync Webhook, and now I no longer seeing that message about not having a valid hook set up. Please try again and let me know if it is working now. Also I think a user named "simpkins" is already an admin and co-maintainer on the RTD fontools account. |
|
Yes I have admin access on the RTD account but not on the fonttools repo. It wouldn't let me re-sync the webhook. I think Cosimo's change should fix this. Hopefully this works for you too @belluzj |
|
|
||
| Example interactive session: | ||
|
|
||
| Python 1.5.2c1 (#43, Mar 9 1999, 13:06:43) [CW PPC w/GUSI w/MSL] |
There was a problem hiding this comment.
Python 1.5.2c1, March 9 1999... 🥲
Lib/fontTools/ttLib/ttFont.py
Outdated
| Args: | ||
| file: Similarly to the constructor, can be either a pathname or a writable | ||
| file object. | ||
| reorderTables (bool): If true (the default), reorder the tables, sorting |
There was a problem hiding this comment.
reorderTables is an Optional[bool]. When it's set to None (e.g. the subsetter does that), it means write tables in whatever order is most convenient (mostly due to inter-table dependencies at compile time) without caring about either the canonical order or the original font order. This should be the fastest mode
| @@ -320,11 +337,15 @@ def importXML(self, fileOrPath, quiet=None): | |||
| reader.read() | |||
|
|
|||
| def isLoaded(self, tag): | |||
| """Return true if the table identified by 'tag' has been | |||
| """Return true if the table identified by ``tag`` has been | |||
| decompiled and loaded into memory.""" | |||
| return tag in self.tables | |||
|
|
|||
| def has_key(self, tag): | |||
There was a problem hiding this comment.
we should deprecate has_key in favour of __contains__ at some point
