e259bf8bbb
style: Fix PEP8 whitespace issues in Python files
...
Done with `autopep8 --select=E2,W2`, fixes:
- E201 - Remove extraneous whitespace.
- E202 - Remove extraneous whitespace.
- E203 - Remove extraneous whitespace.
- E211 - Remove extraneous whitespace.
- E221 - Fix extraneous whitespace around keywords.
- E222 - Fix extraneous whitespace around keywords.
- E223 - Fix extraneous whitespace around keywords.
- E224 - Remove extraneous whitespace around operator.
- E225 - Fix missing whitespace around operator.
- E226 - Fix missing whitespace around operator.
- E227 - Fix missing whitespace around operator.
- E228 - Fix missing whitespace around operator.
- E231 - Add missing whitespace.
- E231 - Fix various deprecated code (via lib2to3).
- E241 - Fix extraneous whitespace around keywords.
- E242 - Remove extraneous whitespace around operator.
- E251 - Remove whitespace around parameter '=' sign.
- E261 - Fix spacing after comment hash.
- E262 - Fix spacing after comment hash.
- E265 - Format block comments.
- E271 - Fix extraneous whitespace around keywords.
- E272 - Fix extraneous whitespace around keywords.
- E273 - Fix extraneous whitespace around keywords.
- E274 - Fix extraneous whitespace around keywords.
- W291 - Remove trailing whitespace.
- W293 - Remove trailing whitespace.
2016-11-02 22:28:28 +01:00
561c1f17a1
style: Start applying PEP8 to Python files, indentation issues
...
Done with `autopep8 --select=E1`, fixes:
- E101 - Reindent all lines.
- E112 - Fix under-indented comments.
- E113 - Fix over-indented comments.
- E115 - Fix under-indented comments.
- E116 - Fix over-indented comments.
- E121 - Fix a badly indented line.
- E122 - Fix a badly indented line.
- E123 - Fix a badly indented line.
- E124 - Fix a badly indented line.
- E125 - Fix indentation undistinguish from the next logical line.
- E126 - Fix a badly indented line.
- E127 - Fix a badly indented line.
- E128 - Fix a badly indented line.
- E129 - Fix a badly indented line.
2016-11-02 22:26:55 +01:00
5a49e45d21
SCsub: Add python shebang as a hint for syntax highlighting
...
Also switch existing shebangs to "better" /usr/bin/env python.
(cherry picked from commit fc8ccd5b8c
2016-10-30 14:51:34 +01:00
5e082d583b
classref: Fix UTF-8 parsing in makerst
2016-06-22 00:32:29 +02:00
034d6e811f
Various improvements to doc_status.py
...
- Make comments opt-in (smaller table in width)
- Reduce length of Brief Description and Description (also smaller table as output)
- Make names cyan (blue is too dark on black terminal)
- Drop some redundant synonyms for the flags
2016-04-26 21:35:06 +02:00
c9340cdcc6
Add a python script to check the current doc status
2016-04-22 18:32:15 +03:00
0a5472e697
Remove trailing spaces
2016-04-02 20:26:12 +02:00
e5389288dd
Add a warning header to each rst file
...
To tell potential contributors that they should direct their work to the XML template and not the auto-generated reST
2016-02-17 22:02:55 +01:00
9e4532d689
Implement support for [codeblock] tag in help
...
It allows to define a multiline space-indented code block that will be properly parsed by the reST converter for the online docs.
The in-editor help understand the [codeblock] tag as it supposedly understand [code] already (i.e. it just seems to discard it, though the code was supposed to switch it to a monospace font, but that's likely another issue.
2016-02-17 21:17:08 +01:00
0f11b322b3
Improve parsing of [method ...] tags
...
Also improve some code display.
2016-02-07 18:30:18 +01:00
1af65aff44
Fix badly formatted tags in XML
...
Also add parsing of [code] tags in RST converter
2016-02-07 17:19:12 +01:00
b766e9c79b
Display better inheritance info in doc
2016-02-07 13:05:16 -03:00
2fabb3e892
Small makerst improvements
2016-02-07 14:43:09 +01:00
47e5a5fd74
Enhance xml to rst converter
...
Fixes a number of issues:
- Headings underliners now have the correct length
- Newline+Tabs in descriptions are replaced by two newlines to make a proper paragraph
- [br] are replaced by two newlines, making a proper paragraph
- Properly parse internal hyperlinks in constants description
- Fix broken internal links due to missing newlines
- Show method header even when it has no description, to have something to reference in hyperlinks
2016-02-07 12:13:19 +01:00
3ee4f4f19a
-Added RST generator for class reference
2016-02-06 20:23:39 -03:00
5be9ff7b67
Update copyright to 2016 in headers
2016-01-01 11:50:53 -02:00
410e418aea
Add a Makefile to generate classes doc in various formats
...
All the generated documentation is put in doc/_build.
2015-12-13 00:01:04 +01:00
aeb5ea5934
Move documentation python tools to doc/tools folder
2015-12-12 23:30:45 +01:00
Rémi Verschelde
Bojidar Marinov
Rémi Verschelde
Juan Linietsky
George Marques