Commit Graph

45 Commits

Author SHA1 Message Date
Erik Johnson
e14f2bea15
Improve Documentation (#835)
* Update installation documentation to include virtualenv example

* Add notice about ampersand replacement in pango markup

* Remove rubric header

* Forgot to add the installation.rst

* Fix typo
2022-01-02 11:05:52 -06:00
Tim Gates
3e9f61dff0
docs: Fix a few typos (#824)
There are small typos in:
- docs/configuration.rst
- i3pystatus/calendar/google.py
- i3pystatus/coin.py
- i3pystatus/core/modules.py
- i3pystatus/ping.py
- i3pystatus/sabnzbd.py
- i3pystatus/timer.py

Fixes:
- Should read `occurred` rather than `occured`.
- Should read `subtracts` rather than `substracts`.
- Should read `specify` rather than `specifiy`.
- Should read `remaining` rather than `remainig`.
- Should read `recommended` rather than `recomended`.
- Should read `property` rather than `propertie`.
- Should read `available` rather than `availible`.
2021-08-30 08:58:04 -05:00
Erik Johnson
cb69563c33
Add documentation on callbacks executing the run() func (#765)
Resolves #378.
2019-10-10 15:15:59 -05:00
chestm007
cf5b4576a8
update docs (#699) 2019-01-08 01:45:13 +11:00
chestm007
75409ce9ad
add background to hints section in docs (#697) 2019-01-08 01:43:52 +11:00
Erik Johnson
394eaf52ee Improve keyring documentation 2016-09-25 14:58:38 -05:00
Matthieu Coudron
33764e349e "logfile" accepts environment variables 2016-08-29 14:54:07 +02:00
ncoop
be27d7839b It makes sense to put Credentials later. 2016-07-30 15:39:14 -07:00
ncoop
80b823fe68 Docs: how and why to customize internet_check 2016-07-30 15:39:04 -07:00
Igor Sharonov
d3ca35ccfb Update docs 2016-07-13 09:47:49 +03:00
Erik Johnson
16b28ec493 Document "logformat" option for i3pystatus.status.Status() 2016-04-10 21:16:23 -05:00
Erik Johnson
3d97ea80b8 Add information on setting logfile in i3pystatus.status.Status() constructor 2016-04-10 21:16:23 -05:00
Erik Johnson
66bc56b7a4 Add reference to weather module to the formatp documentation 2016-03-29 01:14:56 -05:00
facetoe
ee5a706107 Document that the keyring example requires the keyrings.alt package. 2016-02-14 22:07:40 +08:00
facetoe
3addb4b229 Update PlaintextKeyring example with new import location. 2016-02-14 12:15:22 +08:00
enkore
58ca67109c Change default mode to standalone=True 2016-02-12 14:12:43 +01:00
enkore
2890f942f3 configuration.rst: update example callbacks 2016-02-02 16:01:28 +01:00
enkore
2aeda9c5e3 Fix single string case & docs 2016-01-27 20:15:59 +01:00
enkore
a69ad47aac Cf. #284 2015-12-12 11:21:00 +01:00
Lukáš Mandák
6b22ec25e4 Docs: Rewritten Callbacks section of user documentation. 2015-09-25 19:16:04 +02:00
enkore
2c40fa1a48 modrefs 2015-06-22 20:14:17 +02:00
Lukáš Mandák
794d68fe5d Added user documentation about bar refreshing. 2015-06-22 13:52:30 +02:00
enkore
85566a9897 Typo 2015-06-20 10:48:03 +02:00
Lukáš Mandák
b501d22ad9 Moved hints documentation to Configuration section.
Added a few basic examples.
2015-06-19 22:27:16 +02:00
enkore
7df811b9a1 Add callbacks chapter 2015-06-17 18:11:40 +02:00
enkore
09b158a6e1 anchors 2015-06-17 17:39:20 +02:00
enkore
74bffab945 Add Logging chapter 2015-06-17 16:05:09 +02:00
enkore
30a330834f Merge formatting and configuration chapters 2015-06-17 16:05:03 +02:00
enkore
087cec56f0 typo 2015-06-17 15:17:26 +02:00
enkore
9c1ae61c25 Update docs re. credentials 2015-06-17 15:16:40 +02:00
enkore
317d96b176 docs 2015-06-06 00:48:45 +02:00
enkore
72f7b3acf1 Update configuration.rst 2015-06-06 00:28:17 +02:00
enkore
0eca656b1b Update configuration.rst 2015-06-06 00:27:38 +02:00
enkore
508b5a7ada Update configuration.rst 2015-06-06 00:26:15 +02:00
enkore
45f755d4bb Update configuration.rst 2015-06-06 00:25:01 +02:00
enkore
12bfbe895b Python 3 doesn't require that 2015-06-06 00:21:01 +02:00
enkore
5ff2362df3 Update configuration.rst 2015-06-06 00:20:27 +02:00
enkore
f2fa560beb Update configuration.rst 2015-06-06 00:18:03 +02:00
enkore
c6c719dbe6 Update configuration.rst 2015-06-06 00:17:37 +02:00
enkore
565d93b407 Update configuration.rst 2015-06-06 00:16:38 +02:00
enkore
8c70904018 Update configuration.rst 2015-06-06 00:16:03 +02:00
facetoe
d61925ab54 Added documentation on adding specific keyrings. 2015-02-22 10:06:44 +08:00
facetoe
c051e01959 Added documentation of keyring feature. 2015-02-14 10:40:58 +08:00
enkore
936efdde95 Update configuration.rst 2014-10-12 03:02:15 +02:00
enkore
344ad4647f Moved all docs to sphinx. Nothing changes for module authors. 2014-10-12 01:32:29 +02:00