Florian Bruhin
38c341e3ea
Add count info in commands.
2014-09-13 00:33:54 +02:00
Florian Bruhin
80ef0782d5
Improve some docstrings.
2014-09-13 00:22:27 +02:00
Florian Bruhin
070d5ae300
Add more documentation.
2014-09-08 12:21:47 +02:00
Florian Bruhin
880758d04e
Make generate_doc work on Windows
2014-09-08 11:40:27 +02:00
Florian Bruhin
381b06e967
Fix lint
2014-09-08 07:44:32 +02:00
Florian Bruhin
0267dac2be
Add --help documentation
2014-09-08 07:36:18 +02:00
Florian Bruhin
2cc41081b3
Add newline in settings doc.
2014-09-08 07:36:18 +02:00
Florian Bruhin
02e4fdd867
generate_doc: Call asciidoc
2014-09-08 07:36:17 +02:00
Florian Bruhin
8d9dd8e83d
doc: Remove some newlines
2014-09-08 07:36:17 +02:00
Florian Bruhin
e416228713
doc: Add missing blank lines
2014-09-08 07:36:17 +02:00
Florian Bruhin
04c77d4d90
Adjust formatting for arg descriptions
2014-09-08 07:36:17 +02:00
Florian Bruhin
9e3f5e28bc
docs: Fix heading levels
2014-09-08 07:36:17 +02:00
Florian Bruhin
dcfb52847f
Nicer flag output in docs.
2014-09-08 07:36:17 +02:00
Florian Bruhin
9f23e9aa36
Many improvements for generate_doc
2014-09-08 07:36:17 +02:00
Florian Bruhin
02292d8518
generate_doc: Remove unneeded whitespace
2014-09-08 07:36:17 +02:00
Florian Bruhin
a1fabcc5c2
Start rewriting manpage generation
2014-09-08 07:36:17 +02:00
Florian Bruhin
b03b0a173c
generate_doc: Use argparse for command syntax
2014-09-08 07:36:17 +02:00
Florian Bruhin
b453ae563e
Clean up docstring parsing and move it into qutebrowser for commands.
2014-09-08 07:36:17 +02:00
Florian Bruhin
ccfc0b3c19
Get rid of most @property's.
...
They were problematic because they're executing hidden code, and also PyQt
hides exceptions happening inside them.
2014-09-02 23:37:47 +02:00
Florian Bruhin
f6c1c8b73b
generate_doc: Order authors correctly.
2014-08-27 13:16:01 +02:00
Florian Bruhin
ce4a5affa4
Rename commands.utils to commands.cmdutils.
2014-08-26 20:48:39 +02:00
Florian Bruhin
d625cde28c
Clean up imports
2014-08-26 19:10:14 +02:00
Florian Bruhin
c7ee655750
Use pylint to check modelines and fix them.
2014-08-06 23:51:44 +02:00
Florian Bruhin
60d4dafbbb
Replace cgi.escape by html.escape.
...
cgi.escape is deprecated:
https://docs.python.org/3.4/library/cgi.html#cgi.escape
2014-08-05 23:20:26 +02:00
Florian Bruhin
ee1b136807
Clean up pylint/noqa comments.
2014-08-04 03:47:09 +02:00
Florian Bruhin
dea7e35b92
generate_doc: Nicer syntax.
2014-08-03 01:00:25 +02:00
Florian Bruhin
f451d7b98c
generate_doc: Handle empty lines correctly.
2014-08-03 00:58:46 +02:00
Florian Bruhin
ebb9e270d3
Avoid None values in documentation.
2014-08-02 23:57:34 +02:00
Florian Bruhin
cbafd0dbf2
generate_doc: Support multi-line argument description.
2014-08-02 23:34:50 +02:00
Florian Bruhin
61c23f4684
generate_doc: Add varargs to syntax.
2014-08-02 23:03:35 +02:00
Florian Bruhin
f4edb5e9d1
generate_doc: Strip leading * for vararg docs.
2014-08-02 23:03:19 +02:00
Florian Bruhin
55650969b6
generate_doc: Use OrderedDict for argument docs.
2014-08-02 23:02:54 +02:00
Florian Bruhin
f8c995d58d
Support multiline setting descriptions.
2014-08-02 22:53:57 +02:00
Florian Bruhin
44df5754d9
Add shebang to scripts/generate_docs
2014-08-02 21:13:14 +02:00
Florian Bruhin
09cfa7669e
Mark scripts as executable.
2014-07-31 21:09:34 +02:00
Florian Bruhin
860ef75abc
Fix lint
2014-07-28 21:09:49 +02:00
Florian Bruhin
8d80ce2628
Switch to python 3.4 enums.
...
Our home-brewn enum wasn't really liked by pylint (many no-member errors), so
instead of adding some workaround, we just use the python 3.4 enum instead.
This however also means we need to depend on Python 3.4 and not 3.3. Maybe we
should use enum34 on Python < 3.3.
2014-07-28 20:41:42 +02:00
Florian Bruhin
7f3a4298bf
Adjust docstrings
2014-07-24 22:52:53 +02:00
Florian Bruhin
eaed493f85
More manpage improvments
2014-07-24 01:51:23 +02:00
Florian Bruhin
1116d7caeb
Format synopsis in manpage correctly
2014-07-24 00:51:04 +02:00
Florian Bruhin
d4c3a65fe3
Start with manpage generation
2014-07-18 07:48:33 +02:00
Florian Bruhin
8f19da7e54
Fix lint
2014-07-17 21:35:27 +02:00
Florian Bruhin
705a96f6c0
Rename generate_manpage to generate_doc
2014-07-16 22:28:02 +02:00