28 Commits

Author SHA1 Message Date
Jany Belluz
5a842cc249 [designspaceLib] Update documentation and add version 5 2022-04-14 15:05:20 +01:00
Simon Cozens
0f03e6529a
[docs] Fix sphinx warnings (#2453)
* Add default auto doc options

* Ensure all references are unique

* Use anonymous links to avoid duplicate references

* Remove default options, fix wrong module name

* Don’t index repeated class

* Remove repeated classes included through automodule

* Fix warnings

* We don’t use our own static directory

* Correctly format XML in docs

* Fix indentation

* Fix overline

* Bring TOC to top

* Fix definition list

* Offset definition lists and examples

* Fix erroneous markup

* Fix markup

* Already included in automodule

* Fix args markup

* Correct markup for example

* Don’t reindex repeated module

* Correct XML code block markup

* Fix markup errors, change example to doctest

* Correct list markup

* Make ttx docstring both valid RST and valid help output

* Various other boring markup fixes

* Fix example indenting

* Make docstring valid RST and valid help output

* Mock import for reportlab

* It’s ok if manual links don’t appear in toctrees

* Oops typo, I guess doctests are useful
2021-12-02 15:31:49 +00:00
Cosimo Lupo
3be7c05024
Merge pull request #2041 from ctrlcctrlv/patch-1
Better document rule processing order
2020-08-17 15:38:14 +01:00
Fredrick Brennan
6af1f01289
Update readme.rst 2020-08-15 16:21:16 -07:00
Juan del Peral
502e43a4f1
typo 2020-08-13 16:02:48 +02:00
Fredrick Brennan
66a40e039d
Better document rule processing order
Close #2040
2020-08-12 09:33:41 -07:00
Chris Simpkins
d0cdffe437
[Doc] add inherited member docstring parsing support 2020-04-19 14:29:18 -04:00
Ben Kiel
726cd67549
Clarify differences between XML and Python (#1792)
* Clarify differences between XML and Python

* Typo
2019-12-29 10:09:23 -06:00
Just van Rossum
b8fafdd259
[WIP] [designspaceLib] designspace docs edits (#1750)
Various changes in the designspaceLib readme.rst
- added docs for DesignSpaceDocument object, methods and attributes
- removed comments on validation, localisation and generating UFO instances.
- added note that axis minimum, default and maximum are in userspace coordinates.
- added clarification to map input (userpace!) / output (designspace!) values.
- added note that sourceDescriptor location is in designspace coordinates.
- moved comment on rule subs to rule descriptor object.
- added proposed "processing" flag to rules element
- move note on sub element
- implementation differences
- varlib vs. mutatormath
- older versions
- rules and generating static ufo instances
- Updated the description of the `copyInfo` flag of the sourceDescriptor.
- Change the example import.
- Remove additional mention of copyInfo.
2019-11-07 19:30:51 +01:00
Nikolaus Waxweiler
079f68350f [designspaceLib] Document proposed public.skipExportGlyphs lib key (#1534)
* Document proposed public.skipExportGlyphs lib key
2019-03-14 16:06:05 -05:00
Nikolaus Waxweiler
dd40dac5e0 Remove InstanceDescriptor.mutedGlyphNames
Closes https://github.com/fonttools/fonttools/issues/1417.
2019-01-19 14:13:32 +00:00
Cosimo Lupo
1a07ba9bc4
Doc/designspaceLib: clarify labelNames values must always be unicode
otherwise, on py27, we end up writing garbage bytes in name record
strings.
2019-01-13 13:40:04 +00:00
Nikolaus Waxweiler
621c652ad0
[designspaceLib] Documentation: Clarify what min/max/default on an AxisDescriptor mean (#1395)
Clarify that the axis properties refer to user space coordinates
2018-12-19 11:24:07 +00:00
Cosimo Lupo
cafb373bfb
Doc: fix RST formatting 2018-06-07 12:00:29 +01:00
Erik van Blokland
8582dbdd2a WIP. Some comments. 2018-05-27 09:50:00 +02:00
Erik van Blokland
07fb8abac3 WIP
Add clarification about document.lib keys using reverse domain name notation.
Add test for document.lib with some nested data.
2018-05-24 21:42:21 +02:00
Masaya Nakamura
29d3abe920
Fix formatting of DesignSpaceDocument spec 2018-05-21 16:07:09 +09:00
Cosimo Lupo
ceb41ec484 WIP: implement conditionSets in designspaceLib.RuleDescriptor (#1255)
* [designspaceLib] WIP: add conditionSets to RuleDescriptor...

the BaseDocReader still needs to be updated to be able to read both
legacy condition-without-conditionset and new-style conditionset
elements.

* test_rules: replace rule.conditions with conditionSets

* Tests: update test.designspace to use conditionset; replace 'with' with 'byname' in sub element

I don't like too much that now 'byname' precedes alphabetically 'name'.
We need to see if ElementTree allows to sort attribute arbitrarily

* Change versionnumber to 4.0 - would that be enough, or should there be seperate major / minor fields?
If we bump the version up to numeral 4, I'd like the check for the with / byname attributes. We can read the old `byname` and only write the new `with`.
Remove support for `initial` in axis attributes.

* WIP - formatversion, with attribute,

* WIP
anything that is not version 4.0 is version 3.0
added some local paths to the test so I can see what it's generating. I can take this out later.

* WIP
read the conditionsets properly. This makes the tests fail no longer.

* WIP
disambiguate axis tags from axis names. Test axes are now called "axisName_x", tags are called "TAGX"

* WIP forgot to push

* WIP
Raise `DesignSpaceDocumentError` when no maximum or minimum are given in a condition.
Add test for such an incomplete rule.
Remove path cruft.

* WIP improved test of raised error.

* WIP because no bot.

* WIP more spaces around percents.

* WIP - don't skip empty subs, just load whatever is there.

* WIP do not permit empty axes in a location when evaluating a rule. Fix some tests.

* WIP missed a str(tempdir), some rule tests.

* WIP proposal for changes to the designspace spec to the `rule` and `sub` elements.

* WIP edits.

* WIP. Typo.
2018-05-14 11:29:48 +02:00
Cosimo Lupo
f82ef7a410
[Doc/designspaceLib] mention list of 'subs' in RuleDescriptor 2018-05-03 12:27:50 +01:00
Cosimo Lupo
23af3227b7
[Doc/designspaceLib] mark rule 'name' as optional 2018-05-03 11:51:18 +01:00
Cosimo Lupo
162ad1c842
Merge pull request #1254 from fonttools/designspacelib-conditionset-spec
designspaceLib: This adds conditionsets to the rule element.
2018-05-03 11:35:14 +01:00
Erik van Blokland
066a9c9061 This adds conditionsets to the rule element. 2018-04-29 12:23:19 +02:00
Erik van Blokland
1fededb376 Changed sourceDescriptor object attribute to layerName.
Changed non-standard axis name to all caps.
2018-04-28 13:01:25 +02:00
Erik van Blokland
1c6c35dc38 Change to designspace documentation: add layer attribute to the source element.
Add `layerName` attribute to the sourcedescriptor object
Read and write layerName.
Add a source layer test.
XXX this also disables the test_check() test for the moment because it generates odd results.
2018-04-27 13:24:11 +02:00
Jany Belluz
ede5de6fb0 [designspaceLib] Switch doc files for designspaceLib from CRLF to LF 2018-02-14 12:46:55 +00:00
Jany Belluz
483e1489b4 [designspaceLib] Add documentation for new attributes 2018-02-14 12:46:51 +00:00
Jany Belluz
a0a2dcb87f [designspaceLib] Freshen the documentation of designspaceLib 2018-02-14 12:46:47 +00:00
Jany Belluz
cfb2c0bb50 Move the documentation to Sphinx 2017-11-29 12:03:34 +00:00