Commit graph

69 commits

Author SHA1 Message Date
Zach White
cb60d846d9 [ci] Updated API documentation 2022-03-27 19:55:04 +00:00
Zach White
723eb3b21c fix the metadata documentation 2021-11-27 19:31:15 -08:00
Zach White
04d5720e9e [ci] Updated API documentation 2021-09-04 05:49:55 +00:00
Zach White
ec6e81dead
Add the ability to highlight values below a threshold (#43)
* add support for high and low thresholds

* update sparklines documentation

* update the sparkline api docs
2021-08-23 09:42:29 -07:00
Zach White
6df68ef8df [ci] Updated API documentation 2021-08-23 16:08:54 +00:00
Zach White
89ae852ae9 change highlight_color to threshold_color before anyone starts using it 2021-08-23 09:02:11 -07:00
Zach White
aaf79937c3 [ci] Updated API documentation 2021-08-23 15:51:50 +00:00
Zach White
0573a2f2c4 fix indent 2021-08-23 08:40:16 -07:00
Zach White
3c2196adbe remove vestiges of docsify 2021-08-23 08:37:59 -07:00
Zach White
e56bccb3db update old link 2021-08-23 08:37:24 -07:00
Zach White
76cfb4578d Add breaking changes for 1.6.0 2021-08-23 08:37:10 -07:00
Zach White
109ebe3f4d
Switch our documentation to mkdocs material (#42)
* initial version of docs using mkdocs material

* tweak the visual look

* CSS tweaks

* remove _summar

* font tweak

* update README to reflect mkdocs

* workflows to update documentation

* add site to .gitignore
2021-08-23 08:04:15 -07:00
Zach White
ba9958eaf7
Support for displaying sparklines (#41)
* Add support for displaying sparklines

* regenerate api docs

* tweak the script docstring

* improve corner case handling

* improve and document whitespace

* Add the ability to color sparklines to indicate positive and negative numbers

* add the ability to highlight values over a particular threshold

* add unit tests for sparkline

* fix a bug found by the unit tests

* generate docs

* clarify int vs number

* add sparklines to the TOC
2021-08-22 20:21:41 -07:00
Zach White
405a935019 [ci] Updated API documentation 2021-08-10 19:31:20 +00:00
Zach White
71f88bd4f9 add 1.5.0 to breaking changes 2021-08-10 12:13:33 -07:00
Zach White
c96135b60b minor: update docs 2021-08-10 12:09:49 -07:00
Zach White
4e2a63ae76 new: add a cli.config_dir 2021-08-10 12:09:31 -07:00
Fyrebright
a32a8b967b new: Add deprecation to arguments and commands (#39) 2021-08-10 12:03:54 -07:00
Zach White
e64d3313da [ci] Updated API documentation 2021-05-27 02:15:07 +00:00
Zach White
fc6730fae8 improve the docs in preparation for 1.4.0 2021-05-22 23:07:30 -07:00
Zach White
54bb096cb2 update docs 2021-05-21 16:37:38 -07:00
Zach White
ca854efbc6
Only ask questions if we are an interactive process (#30)
* Only ask questions if we are an interactive process

* add tests for the question script

* tweak color

* add a breaking changes entry

* typo

* make ci happy
2021-05-17 16:11:41 -07:00
Zach White
b20f3191a5
Eliminate the need to use environment variables for metadata (#29)
* Eliminate the need to use environment variables for metadata

* properly handle dashes in subcommands

* correctly handle subcommands and arguments with dashes

* fix automatic app name detection

* add a warning about importing set_metadata and cli

* update docs

* yapf

* fix the description for config --all
2021-05-17 13:05:04 -07:00
Zach White
abe1fe4173
Improve the config command (#28)
* The config command now filters out configuration that has not been set

* tweak

* remove print

* typo

* sort the config before printing it
2021-05-16 17:48:04 -07:00
Zach White
7853c00da7 [ci] Updated API documentation 2021-03-28 16:42:16 +00:00
Zach White
9685aa0264 add argcomplete to the summary 2021-03-28 09:30:53 -07:00
Zach White
8cd7d2831a flesh out the argcomplete support 2021-03-28 09:18:54 -07:00
Zach White
b58106021b Support for setting the version number
fixes #14
2021-03-28 07:55:39 -07:00
Zach White
bcb1dd0c27 Overhaul how ansi/unicode are supported
fixes #26
2021-03-28 07:18:45 -07:00
Zach White
32503581d8 misc cleanups 2021-03-28 06:14:04 -07:00
Zach White
1f12db3762 Improve generate_docs
We now automatically update the _summary.md and commit changes if requested.
2021-03-28 05:22:05 -07:00
Zach White
98e7675772 bump supported python versions 2021-03-24 08:48:28 -07:00
Zach White
fa8e9a179c Generated API documentation. 2021-01-02 10:11:35 -08:00
skullY
3b2b84b897 Generated API documentation. 2020-10-25 11:27:46 -07:00
skullY
3d63a49a65 Generated API documentation. 2020-10-22 06:59:48 -07:00
skullY
d4b6f380c8 typo fix 2020-10-10 13:16:13 -07:00
skullY
b4e8fb68b2 improve cli.run docs 2020-10-09 10:39:50 -07:00
skullY
bd9e8ad5ed Document and improve cli.run 2020-10-09 10:11:05 -07:00
skullY
4987c35435 update API docs 2020-10-06 17:40:00 -07:00
skullY
928d1a8246 Generated API documentation. 2020-10-04 10:29:47 -07:00
skullY
4c34230598 Generated API documentation. 2020-04-28 22:57:04 -07:00
skullY
822201bae7 Generated API documentation. 2020-03-30 08:47:24 -07:00
skullY
c132d97636 cleanup a couple QMK references 2020-03-25 11:17:37 -07:00
skullY
952d5b1464 add tests for milc.configuration 2020-03-25 09:52:55 -07:00
skullY
5c8366e7ec add generated api docs 2020-03-12 16:18:14 -07:00
skullY
5497c08a18 clean up the sidebar 2020-03-12 14:50:54 -07:00
skullY
4e9678ba88 remove the link 2020-03-12 13:06:30 -07:00
skullY
674d685dbf make the question.md formatting nicer 2020-03-12 13:05:55 -07:00
skullY
920df1c8c3 remove qmk references 2020-03-12 11:12:40 -07:00
skullY
28ab6c12c0 add some missing docs 2020-03-11 21:26:04 -07:00