e023e05429
Docs: extend settings table
...
The settings table on the website now also includes type and default
value of settings. Required extending the rstutils script.
2023-07-07 15:42:43 +02:00
95e8a269f5
Simplify src2rst script
...
- Replace various map, lambda combinations with comprehensions
- Remove duplication
2023-07-07 15:42:43 +02:00
Jean-Claude
cfb3b3a38e
NEW: doc listing all CLI arguments and some examples
...
also improve the formatting of the man page by combining short- and
longform into brackets
2023-07-07 15:42:43 +02:00
f1a3700bfb
Update copyright for 2023
...
Includes minor reformatting by new black version as all python files
were changed.
2023-01-03 17:02:49 +01:00
68af2ce95f
Update copyright to 2022
2022-01-06 13:33:09 +01:00
0228426bcd
adds encoding="utf-8" everywhere
2021-09-05 13:30:42 -04:00
e17929cc08
Update copyright for 2021
2021-01-17 21:04:25 +01:00
1e70592d46
Remove add_gpl_boilerplate script
...
This has been unused for a while as copy-pasting is simple enough and
the pylint checker ensures we have a copyright everywhere.
2021-01-17 21:02:29 +01:00
aa1db21a85
Check current year in copyright programatically
2021-01-17 21:02:29 +01:00
98bb36ab2a
Add script to print history of single-mode
...
This serves as proof-of-concept how to use python + json to script the
history file in case anyone relied on the plain-text nature of the old
history file.
2020-06-05 15:06:46 +02:00
e93ca036c4
Exit pylint on tests cleanly on errors
...
We do not want to raise an exception here if the returncode of pylint is
non-zero. Instead we want to return with exactly this returncode.
2020-05-20 16:06:40 +02:00
37ededb5f5
Add script to run pylint over tests
...
This is required due to
https://github.com/PyCQA/pylint/issues/352
which makes the CI fail.
In addition it allows documenting and fine-tuning pylint for tests
specifically.
2020-05-07 11:14:32 +02:00
1c908fac0b
Add name for pylint docstring checker
2020-02-09 16:16:18 +01:00
4eec61bf5b
Add pylint checker for file header
...
Checks for:
* Missing vim modeline
* Missing copyright notice
2020-02-09 16:15:25 +01:00
5dbd02f00d
Fix src2rst for lazy imports
...
Some commands were missing in the generated documentation due to them
not being imported.
2020-01-19 03:08:49 +01:00
83e8759dfe
Extend pylint docstr checker for missing docstr
...
This fixes a crash when checking the command docstring for the
appropriate sections in case there is no docstring available.
2020-01-15 13:38:00 +01:00
71a48442ed
Update Copyright for 2020
2020-01-05 17:51:16 +01:00
4fbae91b4d
Unify keybindings in docs and dumped keys.conf
...
Since using a trie for the keybindings, the dumped keys.conf had no more
bindings in global mode. For the website we wrote a specific patch, so
the documentation of the same bindings is not duplicated. This is now
consistent between the default keys.conf and the website.
2019-12-12 22:29:10 +01:00
cb23943451
Remove now unused gen_website script
...
This has been replaced by tox.
2019-12-10 00:31:04 +01:00
e0d10c421d
Update src2rst for new keybindings structure
2019-12-07 20:18:01 +01:00
229af836c9
Update pylint syntax checker for multi-lines
...
Before the **syntax:** section had to be in a single line which is not
feasible for long command options.
2019-11-13 22:40:32 +01:00
4cfa40b61b
Remove duplicate copyright from src2rst
2019-10-30 10:17:56 +01:00
4f75ecda92
Add tox command to ensure building c-extension
...
Locally, when running tox without compiling the c-extension, an
ImportError for _c_manipulate may be raised. This is fixed by this
commit.
2019-09-12 21:57:59 +02:00
c355e951d4
Update manpage and src2rst for development args
2019-08-24 15:55:03 +02:00
2aa781c04c
Fix src2rst script for new parser structure
2019-08-15 13:51:59 +02:00
a1d5ad572f
Catch additional case in pylint docstring checker
2019-06-03 16:25:39 +02:00
5f861d1949
Improve syntax section docstring checker
...
It now also checks if the section is correctly formatted using a regular
expression.
2019-05-27 21:30:49 +02:00
93b1ff481f
Fix command docs fomatting and add checker
...
The pylint checker ensures that a syntax section is available as well as
checking for count and arguments.
2019-05-26 18:04:36 +02:00
b2fbbf378d
Fix src2rst script for vimiv.startup
2019-05-25 01:16:57 +02:00
a4c4600243
Add custom pylint checker for count handling
2019-05-17 00:16:07 +02:00
87b04ca2c6
Add user documentation for plugin support
...
The script src2rst was updated to add information on the available vimiv
plugins.
2019-05-09 18:51:19 +02:00
4a2e2a91d3
Explicitly write widths to rst tables
2019-01-30 19:59:08 +01:00
a3e6e9c111
Rewrite rstutils as context manager
...
This is a lot cleaner than passing the open file around in various
functions.
2019-01-30 19:54:23 +01:00
7f47401160
Sort keybindings in docs according to command name
2019-01-30 19:45:35 +01:00
32dc5574f7
Update API documentation using sphinx autodocs
2019-01-19 16:03:03 +01:00
849f5611db
Update src2rst script
2019-01-12 13:37:16 +01:00
bf026f2f48
Add script to generate man page
2019-01-07 00:55:20 +01:00
14f3a7625a
Generate man page in src2rst script
...
The man page can now be built using sphinx with make man.
2019-01-07 00:43:30 +01:00
5af5e0deb9
Add utility script to generate html website
2019-01-06 22:28:35 +01:00
e216563124
Write documentation for contributing
2019-01-06 21:06:19 +01:00
3999f51fe4
Add keybinding documentation
2019-01-06 02:49:54 +01:00
a39a309e36
Add simple Makefile
2019-01-06 00:17:41 +01:00
1f8e45cbf2
Update copyright to 2019
2019-01-05 17:21:31 +01:00
2c7c5610eb
Fix src2rst script for updated mode structure
2018-12-27 03:43:28 +01:00
fe7cbf6edb
Add scripts to auto-generate docs from code
2018-01-15 18:21:25 +01:00
90b4336b59
Add script to add gpl boilerplate to file
2018-01-04 18:11:24 +01:00
karlch
Jean-Claude