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
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
Chris Simpkins
8cbbb6c338
[Doc] remove reportLabPen docs
...
experimental module
2020-04-19 14:29:18 -04:00
Chris Simpkins
47e98dd71e
[Doc] add ufoLib to TOC
2020-04-19 14:29:18 -04:00
Chris Simpkins
c0611c6ef2
[Doc] remove ufoLib.pointPen doc file
2020-04-19 14:29:18 -04:00
Chris Simpkins
08bcfe81d8
[Doc] add ufoLib documentation files
2020-04-19 14:29:18 -04:00
Chris Simpkins
20b609f838
[Doc] modify ufoLib module doc file path
2020-04-19 14:29:18 -04:00
Chris Simpkins
7916ea8f5c
[docs] convert to built-in Napoleon Sphinx extension
...
available in Sphinx v1.3+
2020-04-19 14:29:18 -04:00
Chris Simpkins
aa050e9fe4
[Doc/README.md] convert to pip install -e . [doc] install approach
2020-04-19 14:29:18 -04:00
Chris Simpkins
798af37daf
[Doc/README.md] improve contributing instructions
...
includes grammar/style improvements
2020-04-19 14:29:18 -04:00
Chris Simpkins
f981737fda
[Doc] Sphinx index page documentation update with Github README
...
translation of the current Github README page to Sphinx rst format with minor formatting updates
2020-04-19 14:29:18 -04:00
Chris Simpkins
8773b1202b
[Doc] initial draft documentation README
...
includes local build documentation, style guide, contributing guide, doc license
2020-04-19 14:29:18 -04:00
Chris Simpkins
607dc172bf
[Doc] update documentation TOC
2020-04-19 14:29:18 -04:00
Chris Simpkins
481bc9e912
[Doc] add varLib.varStore documentation
2020-04-19 14:29:18 -04:00
Chris Simpkins
db06df1622
[Doc] add varLib.plot documentation
2020-04-19 14:29:18 -04:00
Chris Simpkins
2478e88e88
[Doc] add varLib.mvar documentation
2020-04-19 14:29:18 -04:00
Chris Simpkins
eef84ad95d
[Doc] add varLib.iup documentation
2020-04-19 14:29:18 -04:00
