Commit graph

15 commits

Author SHA1 Message Date
Russell Keith-Magee
d423a21f68
Migrate projects to use setup.cfg. 2020-06-07 10:18:16 +08:00
Olga Bulat
113451c4c7 Configure csv table creation and styling
Signed-off-by: Olga Bulat <obulat@gmail.com>
2019-11-02 23:01:06 +03:00
Russell Keith-Magee
8c29995beb
Added tabs for code samples in contribution docs. 2018-01-25 16:58:17 +11:00
Russell Keith-Magee
731e5a7cc1
Merge branch 'master' into restruc_toga 2017-09-10 16:44:20 +10:00
Jonas Schell
2e352582e9 Ported documentation added sphinx ext. napoleon and todo to deal with the new google docstring style.
Signed-off-by: Jonas Schell <jonasschell@ocupe.org>
2017-08-10 18:42:36 +02:00
Daniele Procida
c94e89c0f2 Restructured and improved documentation
* updated Makefile to:
  * create a virtualenv for the documentation (``make install``)
  * provide a ``make run`` command
  * provide a ``make spelling`` command
* added a requirements_docs.txt
* added a spelling_wordlist for special words
* corrected various spelling errors
* updated conf.py to use RTD theme for local building
* restyled documentation home page, added logo
* moved content into tutorial/how-to/reference/background sections as appropriate
* renamed "internals" to "project"
* added internal reference links
* suppressed orphan warning for numerous pages
* updated .gitignore for /docs/env

(cherry picked from commit 96f383f)
Signed-off-by: Jonas Schell <jonasschell@ocupe.org>
2017-08-09 17:53:34 +02:00
Daniele Procida
96f383f086 Restructured and improved documentation
* updated Makefile to:
  * create a virtualenv for the documentation (``make install``)
  * provide a ``make run`` command
  * provide a ``make spelling`` command
* added a requirements_docs.txt
* added a spelling_wordlist for special words
* corrected various spelling errors
* updated conf.py to use RTD theme for local building
* restyled documentation home page, added logo
* moved content into tutorial/how-to/reference/background sections as appropriate
* renamed "internals" to "project"
* added internal reference links
* suppressed orphan warning for numerous pages
* updated .gitignore for /docs/env
2017-08-08 13:26:48 +10:00
Dwight Hubbard
2aeb7d1b8d Minor documentation fixes
1. Add links to the classes in the text at the bottom of the second tutorial
2. Update conf.py to use the sphinx-rtd-theme if can be imported so the documentation can built and tested locally.
3. Fix the headers in the Readme to not be beyond the header text.
2017-05-24 15:06:34 -07:00
Anthony Shaw
23646be6be
apply a better approach to the sphinx doc issue 2017-02-08 17:35:17 +08:00
Anthony Shaw
b9ba311a45
fix the autodoc issue, since the main module runs code on import, set to bypass that code if Sphinx 2017-02-05 20:30:40 +11:00
Russell Keith-Magee
9aba640d76 Fixed #74 -- Corrected configuration and markup errors in docs.
Thanks to @paidhi for the report.
2016-10-26 21:47:54 +08:00
Richard Jones
4f0b761e74 Add extracted reference docs
This patch adds the ability to document the UI toolkit using
base abstract classes, and includes those docs in the reference
doc section.

Signed-off-by: Richard Jones <r1chardj0n3s@gmail.com>
2016-10-23 10:19:07 +08:00
Russell Keith-Magee
af7b8ed5ac Refactored platforms into their own separate repositories. 2016-10-23 10:19:04 +08:00
Russell Keith-Magee
50289f7e25 Renamed project to Toga 2016-10-23 10:18:56 +08:00
Russell Keith-Magee
e4eaec6b37 Initial code commit 2016-10-23 10:18:54 +08:00