324 Commits

Author SHA1 Message Date
Simon Cozens
db8948b654 Document otlLib.builder, high-level lookup builders.
Essentially the documentation from #1995, incorporates @dscorbett
feedback.
2020-07-03 11:38:29 +01:00
Simon Cozens
775dc6074e
fontTools.misc.* documentation, part 2 (#1981)
* Document misc.filenames
* Document misc.fixedTools
* Document misc.intTools
* Document misc.loggingTools
* Document misc.macCreatorType
* Document misc.macRes
* Document misc.plistlib
2020-06-08 15:53:48 +01:00
Simon Cozens
76902b7129
[docs] fontTools.misc.* part 1 (#1956)
* Document misc.arrayTools
* Document misc.bezierTools
* Document cliTools
* Document eexec
2020-05-19 09:51:17 +01:00
Simon Cozens
ecc764ecc0
[docs] Document cu2qu library (#1937)
[docs] Document cu2qu library

Reorganise the documentation so that everything is in one place and users are more clearly pointed to the modules which are likely to be useful for their purposes. (I still think it’s worth having at least a brief reference to ``cu2qu.cli`` in there, as a way of reminding users that there is a command-line implementation.) Docstrings are provided for non-API methods where I could understand them - trusting these will be useful for future maintainers.
2020-05-15 10:53:41 +01:00
Cosimo Lupo
d3bd81335e
Merge pull request #1958 from anthrotype/tox-skip-missing-interpreters
tox: add skip_missing_interpreters=true
2020-05-15 10:30:06 +01:00
Cosimo Lupo
0c3efde05e
developer.rst: minor editorial change [skip ci] 2020-05-15 10:23:34 +01:00
Cosimo Lupo
c1f6b4d0f1
tox: add skip_missing_interpreters=true
https://tox.readthedocs.io/en/latest/config.html#conf-skip_missing_interpreters

Runing `tox` with no options runs the tests agaist all the python
environments listed in the `tox.ini`'s `envlist` (currently 3.6, 3.7 and 3.8).

Before this change, if any of these versions was not available, tox would exit with an error. Now it will simply continue (with a warning).

This can be useful when on a developer box, one might only have a subset of all our supported interpreters installed but we don’t want to mark the build as failed because of it.

Note that on the CI I am passing the opposite command line switch to override this setting, because there I want to make sure none of the specified interpreters is skipped.
2020-05-15 10:06:35 +01:00
Simon Cozens
8d32a24710
[docs] Source documentation for cffLib (#1935)
* [docs] Source documentation for cffLib

* Address feedback
2020-05-14 17:04:34 +01:00
Simon Cozens
f3f2793444
[docs] Document fontTools.merge (#1949)
[docs] Document fontTools.merge
2020-05-14 10:06:13 +01:00
Simon Cozens
c89c9487f1
[docs] encodings library (#1940)
Document the ``encodings.codecs`` part which might be useful to some people, and add a brief note about MacRoman.
2020-05-13 10:22:06 +01:00
Simon Cozens
ca8703f653
[docs] Document feaLib (#1941)
[docs] Document feaLib

* Rearrange docs by user intention, highlighting the things you can do with each component.
* Remove reference to lexer and error modules from documentation tree, since they’re not user-facing.
* I’ve added docstrings to the parser even though we only provide access to the user-facing part of the API in the main documentation, just to clarify what some of the more obscure methods do and provide links to the spec.
* AST *is* user-facing if you’re building your own feature files in code, so all classes are documented with the user in mind.
2020-05-12 23:11:17 +01:00
Simon Cozens
a114ec2c20
[docs] Reorganise colorLib docs (#1936)
Does not add any new documentation (there is already some documentation for user-facing functions). It just makes colorLib.builder the top-level documentation entry, because that’s the part the user needs to care about.
2020-05-12 11:19:17 +01:00
Simon Cozens
94cb1759f7
[docs] Document afmLib (#1933) 2020-05-12 11:18:36 +01:00
Simon Cozens
50c77c138e
Merge pull request #1934 from simoncozens/agl-docs
[docs] Document agl.py
2020-05-08 07:03:42 +01:00
Simon Cozens
a59166bbb6
Merge pull request #1914 from simoncozens/documentation
Tidy up top-level documentation and README
2020-05-07 21:45:58 +01:00
Simon Cozens
9b6fed82ca [docs] Document agl.py 2020-05-07 21:31:44 +01:00
Simon Cozens
ab7c31d4f7 [docs] Add remaining commands to doc index 2020-05-07 14:55:55 +01:00
pyup-bot
130b256727 Update sphinx from 3.0.2 to 3.0.3 2020-05-04 16:37:06 +01:00
Simon Cozens
52298f273c [docs] Update buildTableList to write documentation into ttx.rst
Have to do this a little bit differently because of the way that RtD handles comments/code blocks.
2020-05-03 22:53:59 +01:00
Simon Cozens
7a59d8105b [doc] Tidy up top-level access to documentation
* List all modules and utilities
* Move wordy optional requirements to separate page
* Remove cruft from README and add pointers to online documentation
2020-05-03 22:04:55 +01:00
Simon Cozens
9691acb15d [docs] Make front page user-facing, separate developer info 2020-05-03 22:03:26 +01:00
Simon Cozens
7b894956d5 [doc] Add a doc coverage report
So we know how bad things are
2020-05-03 22:03:26 +01:00
Chris Simpkins
414c66f752
[Doc/source/index.rst] indent list items with line breaks 2020-04-22 12:15:33 -04:00
Chris Simpkins
7468572ef3
[Doc] update home page so that it is consistent with repo README 2020-04-22 00:08:23 -04:00
Chris Simpkins
cfbe69fe7f
fix table doc paths to address autodoc import failures 2020-04-22 00:07:48 -04:00
Chris Simpkins
cff2fb3b99
add missing documentation modules 2020-04-22 00:07:03 -04:00
Chris Simpkins
f5336c2aab
[Doc/docs-requirements.txt] add reportlab dependency to build reportLabPen docs 2020-04-22 00:06:40 -04:00
Nikolaus Waxweiler
92e8bc5cce Add missing pen documentation
Ignore reportLabPen for now, as reportlab is a missing dependency usually.
2020-04-21 11:40:40 +01:00
Chris Simpkins
574ea8e363
[Doc] add gitter channel link for dev discussion 2020-04-20 18:45:14 -04:00
Chris Simpkins
e86f965bb5
[Doc varLib] add missing varLib module documentation 2020-04-20 18:40:51 -04:00
Chris Simpkins
45cd55a5e0
[Doc ufoLib] add missing ufoLib module documentation 2020-04-20 18:31:05 -04:00
Chris Simpkins
8c691d3d44
[Docs ttLib/tables] add all missing tables, add docs on how to implement own table converter 2020-04-20 18:25:09 -04:00
Chris Simpkins
e223f6ec45
[Doc] update subset documentation, add subset.cff 2020-04-20 17:52:35 -04:00
Chris Simpkins
84cce30d95
[Doc] add cu2qu documentation 2020-04-20 17:43:06 -04:00
Chris Simpkins
5bb64021d4
[Docs] add colorLib documentation 2020-04-20 17:36:25 -04:00
Chris Simpkins
0cee574571
[Docs/source/index.rst] Py3.6+ documentation 2020-04-20 16:35:51 -04:00
Chris Simpkins
566d50162d
[Doc/source/conf.py] configuration updates 2020-04-20 16:24:35 -04:00
Chris Simpkins
f1b3756a5f
[Doc] add favicon for RTD docs 2020-04-20 16:24:10 -04:00
Chris Simpkins
60cf67c2f5
[Doc/README.md] update documentation build instructions 2020-04-20 13:59:58 -04:00
Chris Simpkins
ee983ced06
add docs requirements.txt file for doc only build dependencies 2020-04-20 13:35:47 -04:00
Chris Simpkins
5cba1d89f2
[docs/source/conf.py] update sphinx docs build config 2020-04-20 13:35:33 -04:00
Chris Simpkins
af7bf650d3
[Doc/source/index.rst] remove inspect documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
87c608675f
[Doc] add badges 2020-04-19 14:29:18 -04:00
Chris Simpkins
99ab48a369
[Docs] add ufoLib dependencies to documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
abbdc3303b
[Doc] add library caption to main TOC 2020-04-19 14:29:18 -04:00
Chris Simpkins
cf9afeb9ea
[Doc] add Font Tools logo to home page 2020-04-19 14:29:18 -04:00
Chris Simpkins
d314400678
[Doc] removed duplicated MIT license text on home page 2020-04-19 14:29:18 -04:00
Chris Simpkins
cc0f21d6e6
[Doc] typo fix encodings TOC 2020-04-19 14:29:18 -04:00
Chris Simpkins
5ec8d924c0
[Doc] remove varLib.designspace documentation
the module was removed from the source
2020-04-19 14:29:18 -04:00
Chris Simpkins
d0cdffe437
[Doc] add inherited member docstring parsing support 2020-04-19 14:29:18 -04:00