From a41817f4385d03b28dfb33d8f3efcc5abd8edb42 Mon Sep 17 00:00:00 2001 From: Abraham Toriz Date: Sat, 17 Sep 2022 23:22:22 -0400 Subject: [PATCH] restart the docs --- docs/.gitignore | 1 + docs/{en => }/Makefile | 0 docs/Pipfile | 12 -- docs/Pipfile.lock | 268 ------------------------------ docs/en/source/advanced_usage.rst | 12 -- docs/en/source/basic_usage.rst | 62 ------- docs/en/source/conf.py | 55 ------ docs/en/source/index.rst | 52 ------ docs/es/Makefile | 20 --- docs/es/make.bat | 35 ---- docs/es/source/advanced_usage.rst | 12 -- docs/es/source/basic_usage.rst | 62 ------- docs/es/source/conf.py | 62 ------- docs/es/source/index.rst | 50 ------ docs/{en => }/make.bat | 4 +- docs/source/conf.py | 28 ++++ docs/source/index.rst | 20 +++ 17 files changed, 51 insertions(+), 704 deletions(-) create mode 100644 docs/.gitignore rename docs/{en => }/Makefile (100%) delete mode 100644 docs/Pipfile delete mode 100644 docs/Pipfile.lock delete mode 100644 docs/en/source/advanced_usage.rst delete mode 100644 docs/en/source/basic_usage.rst delete mode 100644 docs/en/source/conf.py delete mode 100644 docs/en/source/index.rst delete mode 100644 docs/es/Makefile delete mode 100644 docs/es/make.bat delete mode 100644 docs/es/source/advanced_usage.rst delete mode 100644 docs/es/source/basic_usage.rst delete mode 100644 docs/es/source/conf.py delete mode 100644 docs/es/source/index.rst rename docs/{en => }/make.bat (95%) create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..84c048a --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +/build/ diff --git a/docs/en/Makefile b/docs/Makefile similarity index 100% rename from docs/en/Makefile rename to docs/Makefile diff --git a/docs/Pipfile b/docs/Pipfile deleted file mode 100644 index d720a7f..0000000 --- a/docs/Pipfile +++ /dev/null @@ -1,12 +0,0 @@ -[[source]] -url = "https://pypi.org/simple" -verify_ssl = true -name = "pypi" - -[packages] -sphinx = "*" - -[dev-packages] - -[requires] -python_version = "3.9" diff --git a/docs/Pipfile.lock b/docs/Pipfile.lock deleted file mode 100644 index 44750b0..0000000 --- a/docs/Pipfile.lock +++ /dev/null @@ -1,268 +0,0 @@ -{ - "_meta": { - "hash": { - "sha256": "e879b252b55733ab98d1dcd005f029f322788f15b4ee5dd35a2a3d7730680920" - }, - "pipfile-spec": 6, - "requires": { - "python_version": "3.9" - }, - "sources": [ - { - "name": "pypi", - "url": "https://pypi.org/simple", - "verify_ssl": true - } - ] - }, - "default": { - "alabaster": { - "hashes": [ - "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359", - "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02" - ], - "version": "==0.7.12" - }, - "babel": { - "hashes": [ - "sha256:ab49e12b91d937cd11f0b67cb259a57ab4ad2b59ac7a3b41d6c06c0ac5b0def9", - "sha256:bc0c176f9f6a994582230df350aa6e05ba2ebe4b3ac317eab29d9be5d2768da0" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==2.9.1" - }, - "certifi": { - "hashes": [ - "sha256:78884e7c1d4b00ce3cea67b44566851c4343c120abd683433ce934a68ea58872", - "sha256:d62a0163eb4c2344ac042ab2bdf75399a71a2d8c7d47eac2e2ee91b9d6339569" - ], - "version": "==2021.10.8" - }, - "charset-normalizer": { - "hashes": [ - "sha256:e019de665e2bcf9c2b64e2e5aa025fa991da8720daa3c1138cadd2fd1856aed0", - "sha256:f7af805c321bfa1ce6714c51f254e0d5bb5e5834039bc17db7ebe3a4cec9492b" - ], - "markers": "python_version >= '3'", - "version": "==2.0.7" - }, - "docutils": { - "hashes": [ - "sha256:686577d2e4c32380bb50cbb22f575ed742d58168cee37e99117a854bcd88f125", - "sha256:cf316c8370a737a022b72b56874f6602acf974a37a9fba42ec2876387549fc61" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", - "version": "==0.17.1" - }, - "idna": { - "hashes": [ - "sha256:84d9dd047ffa80596e0f246e2eab0b391788b0503584e8945f2368256d2735ff", - "sha256:9d643ff0a55b762d5cdb124b8eaa99c66322e2157b69160bc32796e824360e6d" - ], - "markers": "python_version >= '3'", - "version": "==3.3" - }, - "imagesize": { - "hashes": [ - "sha256:6965f19a6a2039c7d48bca7dba2473069ff854c36ae6f19d2cde309d998228a1", - "sha256:b1f6b5a4eab1f73479a50fb79fcf729514a900c341d8503d62a62dbc4127a2b1" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==1.2.0" - }, - "jinja2": { - "hashes": [ - "sha256:827a0e32839ab1600d4eb1c4c33ec5a8edfbc5cb42dafa13b81f182f97784b45", - "sha256:8569982d3f0889eed11dd620c706d39b60c36d6d25843961f33f77fb6bc6b20c" - ], - "markers": "python_version >= '3.6'", - "version": "==3.0.2" - }, - "markupsafe": { - "hashes": [ - "sha256:01a9b8ea66f1658938f65b93a85ebe8bc016e6769611be228d797c9d998dd298", - "sha256:023cb26ec21ece8dc3907c0e8320058b2e0cb3c55cf9564da612bc325bed5e64", - "sha256:0446679737af14f45767963a1a9ef7620189912317d095f2d9ffa183a4d25d2b", - "sha256:04635854b943835a6ea959e948d19dcd311762c5c0c6e1f0e16ee57022669194", - "sha256:0717a7390a68be14b8c793ba258e075c6f4ca819f15edfc2a3a027c823718567", - "sha256:0955295dd5eec6cb6cc2fe1698f4c6d84af2e92de33fbcac4111913cd100a6ff", - "sha256:0d4b31cc67ab36e3392bbf3862cfbadac3db12bdd8b02a2731f509ed5b829724", - "sha256:10f82115e21dc0dfec9ab5c0223652f7197feb168c940f3ef61563fc2d6beb74", - "sha256:168cd0a3642de83558a5153c8bd34f175a9a6e7f6dc6384b9655d2697312a646", - "sha256:1d609f577dc6e1aa17d746f8bd3c31aa4d258f4070d61b2aa5c4166c1539de35", - "sha256:1f2ade76b9903f39aa442b4aadd2177decb66525062db244b35d71d0ee8599b6", - "sha256:20dca64a3ef2d6e4d5d615a3fd418ad3bde77a47ec8a23d984a12b5b4c74491a", - "sha256:2a7d351cbd8cfeb19ca00de495e224dea7e7d919659c2841bbb7f420ad03e2d6", - "sha256:2d7d807855b419fc2ed3e631034685db6079889a1f01d5d9dac950f764da3dad", - "sha256:2ef54abee730b502252bcdf31b10dacb0a416229b72c18b19e24a4509f273d26", - "sha256:36bc903cbb393720fad60fc28c10de6acf10dc6cc883f3e24ee4012371399a38", - "sha256:37205cac2a79194e3750b0af2a5720d95f786a55ce7df90c3af697bfa100eaac", - "sha256:3c112550557578c26af18a1ccc9e090bfe03832ae994343cfdacd287db6a6ae7", - "sha256:3dd007d54ee88b46be476e293f48c85048603f5f516008bee124ddd891398ed6", - "sha256:4296f2b1ce8c86a6aea78613c34bb1a672ea0e3de9c6ba08a960efe0b0a09047", - "sha256:47ab1e7b91c098ab893b828deafa1203de86d0bc6ab587b160f78fe6c4011f75", - "sha256:49e3ceeabbfb9d66c3aef5af3a60cc43b85c33df25ce03d0031a608b0a8b2e3f", - "sha256:4dc8f9fb58f7364b63fd9f85013b780ef83c11857ae79f2feda41e270468dd9b", - "sha256:4efca8f86c54b22348a5467704e3fec767b2db12fc39c6d963168ab1d3fc9135", - "sha256:53edb4da6925ad13c07b6d26c2a852bd81e364f95301c66e930ab2aef5b5ddd8", - "sha256:5855f8438a7d1d458206a2466bf82b0f104a3724bf96a1c781ab731e4201731a", - "sha256:594c67807fb16238b30c44bdf74f36c02cdf22d1c8cda91ef8a0ed8dabf5620a", - "sha256:5b6d930f030f8ed98e3e6c98ffa0652bdb82601e7a016ec2ab5d7ff23baa78d1", - "sha256:5bb28c636d87e840583ee3adeb78172efc47c8b26127267f54a9c0ec251d41a9", - "sha256:60bf42e36abfaf9aff1f50f52644b336d4f0a3fd6d8a60ca0d054ac9f713a864", - "sha256:611d1ad9a4288cf3e3c16014564df047fe08410e628f89805e475368bd304914", - "sha256:6300b8454aa6930a24b9618fbb54b5a68135092bc666f7b06901f897fa5c2fee", - "sha256:63f3268ba69ace99cab4e3e3b5840b03340efed0948ab8f78d2fd87ee5442a4f", - "sha256:6557b31b5e2c9ddf0de32a691f2312a32f77cd7681d8af66c2692efdbef84c18", - "sha256:693ce3f9e70a6cf7d2fb9e6c9d8b204b6b39897a2c4a1aa65728d5ac97dcc1d8", - "sha256:6a7fae0dd14cf60ad5ff42baa2e95727c3d81ded453457771d02b7d2b3f9c0c2", - "sha256:6c4ca60fa24e85fe25b912b01e62cb969d69a23a5d5867682dd3e80b5b02581d", - "sha256:6fcf051089389abe060c9cd7caa212c707e58153afa2c649f00346ce6d260f1b", - "sha256:7d91275b0245b1da4d4cfa07e0faedd5b0812efc15b702576d103293e252af1b", - "sha256:89c687013cb1cd489a0f0ac24febe8c7a666e6e221b783e53ac50ebf68e45d86", - "sha256:8d206346619592c6200148b01a2142798c989edcb9c896f9ac9722a99d4e77e6", - "sha256:905fec760bd2fa1388bb5b489ee8ee5f7291d692638ea5f67982d968366bef9f", - "sha256:97383d78eb34da7e1fa37dd273c20ad4320929af65d156e35a5e2d89566d9dfb", - "sha256:984d76483eb32f1bcb536dc27e4ad56bba4baa70be32fa87152832cdd9db0833", - "sha256:99df47edb6bda1249d3e80fdabb1dab8c08ef3975f69aed437cb69d0a5de1e28", - "sha256:9f02365d4e99430a12647f09b6cc8bab61a6564363f313126f775eb4f6ef798e", - "sha256:a30e67a65b53ea0a5e62fe23682cfe22712e01f453b95233b25502f7c61cb415", - "sha256:ab3ef638ace319fa26553db0624c4699e31a28bb2a835c5faca8f8acf6a5a902", - "sha256:aca6377c0cb8a8253e493c6b451565ac77e98c2951c45f913e0b52facdcff83f", - "sha256:add36cb2dbb8b736611303cd3bfcee00afd96471b09cda130da3581cbdc56a6d", - "sha256:b2f4bf27480f5e5e8ce285a8c8fd176c0b03e93dcc6646477d4630e83440c6a9", - "sha256:b7f2d075102dc8c794cbde1947378051c4e5180d52d276987b8d28a3bd58c17d", - "sha256:baa1a4e8f868845af802979fcdbf0bb11f94f1cb7ced4c4b8a351bb60d108145", - "sha256:be98f628055368795d818ebf93da628541e10b75b41c559fdf36d104c5787066", - "sha256:bf5d821ffabf0ef3533c39c518f3357b171a1651c1ff6827325e4489b0e46c3c", - "sha256:c47adbc92fc1bb2b3274c4b3a43ae0e4573d9fbff4f54cd484555edbf030baf1", - "sha256:cdfba22ea2f0029c9261a4bd07e830a8da012291fbe44dc794e488b6c9bb353a", - "sha256:d6c7ebd4e944c85e2c3421e612a7057a2f48d478d79e61800d81468a8d842207", - "sha256:d7f9850398e85aba693bb640262d3611788b1f29a79f0c93c565694658f4071f", - "sha256:d8446c54dc28c01e5a2dbac5a25f071f6653e6e40f3a8818e8b45d790fe6ef53", - "sha256:deb993cacb280823246a026e3b2d81c493c53de6acfd5e6bfe31ab3402bb37dd", - "sha256:e0f138900af21926a02425cf736db95be9f4af72ba1bb21453432a07f6082134", - "sha256:e9936f0b261d4df76ad22f8fee3ae83b60d7c3e871292cd42f40b81b70afae85", - "sha256:f0567c4dc99f264f49fe27da5f735f414c4e7e7dd850cfd8e69f0862d7c74ea9", - "sha256:f5653a225f31e113b152e56f154ccbe59eeb1c7487b39b9d9f9cdb58e6c79dc5", - "sha256:f826e31d18b516f653fe296d967d700fddad5901ae07c622bb3705955e1faa94", - "sha256:f8ba0e8349a38d3001fae7eadded3f6606f0da5d748ee53cc1dab1d6527b9509", - "sha256:f9081981fe268bd86831e5c75f7de206ef275defcb82bc70740ae6dc507aee51", - "sha256:fa130dd50c57d53368c9d59395cb5526eda596d3ffe36666cd81a44d56e48872" - ], - "markers": "python_version >= '3.6'", - "version": "==2.0.1" - }, - "packaging": { - "hashes": [ - "sha256:7dc96269f53a4ccec5c0670940a4281106dd0bb343f47b7471f779df49c2fbe7", - "sha256:c86254f9220d55e31cc94d69bade760f0847da8000def4dfe1c6b872fd14ff14" - ], - "markers": "python_version >= '3.6'", - "version": "==21.0" - }, - "pygments": { - "hashes": [ - "sha256:b8e67fe6af78f492b3c4b3e2970c0624cbf08beb1e493b2c99b9fa1b67a20380", - "sha256:f398865f7eb6874156579fdf36bc840a03cab64d1cde9e93d68f46a425ec52c6" - ], - "markers": "python_version >= '3.5'", - "version": "==2.10.0" - }, - "pyparsing": { - "hashes": [ - "sha256:84196357aa3566d64ad123d7a3c67b0e597a115c4934b097580e5ce220b91531", - "sha256:fd93fc45c47893c300bd98f5dd1b41c0e783eaeb727e7cea210dcc09d64ce7c3" - ], - "markers": "python_version >= '3.6'", - "version": "==3.0.1" - }, - "pytz": { - "hashes": [ - "sha256:3672058bc3453457b622aab7a1c3bfd5ab0bdae451512f6cf25f64ed37f5b87c", - "sha256:acad2d8b20a1af07d4e4c9d2e9285c5ed9104354062f275f3fcd88dcef4f1326" - ], - "version": "==2021.3" - }, - "requests": { - "hashes": [ - "sha256:6c1246513ecd5ecd4528a0906f910e8f0f9c6b8ec72030dc9fd154dc1a6efd24", - "sha256:b8aa58f8cf793ffd8782d3d8cb19e66ef36f7aba4353eec859e74678b01b07a7" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", - "version": "==2.26.0" - }, - "snowballstemmer": { - "hashes": [ - "sha256:b51b447bea85f9968c13b650126a888aabd4cb4463fca868ec596826325dedc2", - "sha256:e997baa4f2e9139951b6f4c631bad912dfd3c792467e2f03d7239464af90e914" - ], - "version": "==2.1.0" - }, - "sphinx": { - "hashes": [ - "sha256:94078db9184491e15bce0a56d9186e0aec95f16ac20b12d00e06d4e36f1058a6", - "sha256:98a535c62a4fcfcc362528592f69b26f7caec587d32cd55688db580be0287ae0" - ], - "index": "pypi", - "version": "==4.2.0" - }, - "sphinxcontrib-applehelp": { - "hashes": [ - "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a", - "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58" - ], - "markers": "python_version >= '3.5'", - "version": "==1.0.2" - }, - "sphinxcontrib-devhelp": { - "hashes": [ - "sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e", - "sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4" - ], - "markers": "python_version >= '3.5'", - "version": "==1.0.2" - }, - "sphinxcontrib-htmlhelp": { - "hashes": [ - "sha256:d412243dfb797ae3ec2b59eca0e52dac12e75a241bf0e4eb861e450d06c6ed07", - "sha256:f5f8bb2d0d629f398bf47d0d69c07bc13b65f75a81ad9e2f71a63d4b7a2f6db2" - ], - "markers": "python_version >= '3.6'", - "version": "==2.0.0" - }, - "sphinxcontrib-jsmath": { - "hashes": [ - "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178", - "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8" - ], - "markers": "python_version >= '3.5'", - "version": "==1.0.1" - }, - "sphinxcontrib-qthelp": { - "hashes": [ - "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72", - "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6" - ], - "markers": "python_version >= '3.5'", - "version": "==1.0.3" - }, - "sphinxcontrib-serializinghtml": { - "hashes": [ - "sha256:352a9a00ae864471d3a7ead8d7d79f5fc0b57e8b3f95e9867eb9eb28999b92fd", - "sha256:aa5f6de5dfdf809ef505c4895e51ef5c9eac17d0f287933eb49ec495280b6952" - ], - "markers": "python_version >= '3.5'", - "version": "==1.1.5" - }, - "urllib3": { - "hashes": [ - "sha256:4987c65554f7a2dbf30c18fd48778ef124af6fab771a377103da0585e2336ece", - "sha256:c4fdf4019605b6e5423637e01bc9fe4daef873709a7973e195ceba0a62bbc844" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'", - "version": "==1.26.7" - } - }, - "develop": {} -} diff --git a/docs/en/source/advanced_usage.rst b/docs/en/source/advanced_usage.rst deleted file mode 100644 index 6d3f977..0000000 --- a/docs/en/source/advanced_usage.rst +++ /dev/null @@ -1,12 +0,0 @@ -Advanced Usage -============== - -Subcommands ------------ - -bla - -Settings --------- - -bla diff --git a/docs/en/source/basic_usage.rst b/docs/en/source/basic_usage.rst deleted file mode 100644 index 581dddf..0000000 --- a/docs/en/source/basic_usage.rst +++ /dev/null @@ -1,62 +0,0 @@ -Intro -===== - -What is Tiempo --------------- - -Tiempo is a command line time tracker. It helps you keep track of the time spent -in different activities optionally organized in projects or `sheets`. Tiempo is -also a `Timetrap`_ compatible command line time tracking application. - - Why another time tracking instead of improving Timetrap? - -* Timetrap is `hard to install`_, hard to keep `updated`_ (because of Ruby). - With Tiempo you can get or build a binary, put it somewhere, and it will - just work forever in that machine. I'm bundling SQLite. -* Timetrap is slow (no way around it, because of Ruby), some commands take up to - a second. Tiempo always feels snappy. -* Timetrap needed major refactor to fix the timezone problem (in a language I'm not - proficient with). I was aware of this problem and designed Tiempo to store - timestamps in UTC while at the same time being able to work with a database - made by Timetrap without messing up. And there are a lot of tests backing this - assertions. - -Tiempo has other advantages: - -* Fixed some input inconsistencies. -* Solved some old issues in Timetrap. -* Columns in the output are always aligned. -* CLI interface is easier to discover (ask ``-h`` for any sub-command). -* End times are printed with +1d to indicate that the activity ended the next - day in the 'text' formatter. - -Installation ------------- - -Just do: - -.. code:: bash - - cargo install tiempo - -If you use Arch Linux, install `tiempo-git` package from the `AUR`_, for example: - -.. code:: bash - - git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si - -.. NOTE:: - You need to install `Rust`_ and `Cargo`_. For more info `click here`_. - -Quickstart ----------- - -TODO - -.. _Timetrap: https://github.com/samg/timetrap/ -.. _hard to install: https://github.com/samg/timetrap/issues/176 -.. _updated: https://github.com/samg/timetrap/issues/174 -.. _click here: https://doc.rust-lang.org/cargo/getting-started/installation.html -.. _Rust: https://rust-lang.org -.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html -.. _AUR: https://aur.archlinux.org/packages/tiempo-git/ diff --git a/docs/en/source/conf.py b/docs/en/source/conf.py deleted file mode 100644 index a5c3d06..0000000 --- a/docs/en/source/conf.py +++ /dev/null @@ -1,55 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - - -# -- Project information ----------------------------------------------------- - -project = 'tiempo' -copyright = '2021, Abbraham Toriz' -author = 'Abbraham Toriz' - -# The full version, including alpha/beta/rc tags -release = 'v1.1.1' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'alabaster' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/en/source/index.rst b/docs/en/source/index.rst deleted file mode 100644 index 4d1a3c5..0000000 --- a/docs/en/source/index.rst +++ /dev/null @@ -1,52 +0,0 @@ -Tiempo docs -=========== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - basic_usage - advanced_usage - -Tiempo is a command line time tracker. It helps you keep track of the time spent -in different activities optionally organized in projects or `sheets`. Tiempo is -also compatible with `Timetrap`_, its predecesor. - -Installation ------------- - -Provided you have a `Rust`_ toolchain installed, just do: - -.. code:: bash - - cargo install tiempo - -If you use Arch Linux, install ``tiempo-git`` package from the `AUR`_, for -example: - -.. code:: bash - - git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si - -.. NOTE:: - You need to install `Rust`_ and `Cargo`_. For more info `click here`_. - -Quickstart ----------- - -Go `here`_... - -Special Thanks --------------- - -To `Timetrap`_ for existing, to `samg`_ for creating it. It is the tool I was -looking for and whose design I took as reference, keeping compatibility when -possible. - -.. _Timetrap: https://github.com/samg/timetrap/ -.. _samg: https://github.com/samg -.. _here: basic_usage.html#quickstart -.. _click here: https://doc.rust-lang.org/cargo/getting-started/installation.html -.. _Rust: https://rust-lang.org -.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html -.. _AUR: https://aur.archlinux.org/packages/tiempo-git/ diff --git a/docs/es/Makefile b/docs/es/Makefile deleted file mode 100644 index d0c3cbf..0000000 --- a/docs/es/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/es/make.bat b/docs/es/make.bat deleted file mode 100644 index 6fcf05b..0000000 --- a/docs/es/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/es/source/advanced_usage.rst b/docs/es/source/advanced_usage.rst deleted file mode 100644 index 6d3f977..0000000 --- a/docs/es/source/advanced_usage.rst +++ /dev/null @@ -1,12 +0,0 @@ -Advanced Usage -============== - -Subcommands ------------ - -bla - -Settings --------- - -bla diff --git a/docs/es/source/basic_usage.rst b/docs/es/source/basic_usage.rst deleted file mode 100644 index 83a15f2..0000000 --- a/docs/es/source/basic_usage.rst +++ /dev/null @@ -1,62 +0,0 @@ -Introducción -============ - -¿Qué es Tiempo? ---------------- - -Tiempo es una herramienta de línea de comandos para rastrear el tiempo. Te ayuda a grabar -el tiempo empleado en diferentes actividades y de manera opcional te permite organizarlas -en proyectos o `sheets` (hojas). Tiempo es compatible con `Timetrap`_, su predecesor. - - ¿Por qué otro rastreador de tiempo en lugar de mejorar Timetrap? - -* Timetrap es `difícil de instalar`_, difícil de mantenerlo `actualizado`_ (debido a Ruby). - Con Tiempo puedes obtener o compilar un binario, ponerlo donde sea y simplemente funcionará - en la máquina. Estoy embebiendo SQLite. -* Timetrap es lento (no hay modo de sacarle la vuelta, es por Ruby), algunos comandos - tardan hasta un segundo. Tiempo siempre se siente rápido. -* Timetrap necesitaba una refactorización mayor para arreglar un problema con el huso - horario (en un lenguaje en el que no soy experto). Estaba al tanto de este problema - y diseñé Tiempo para guardar marcas de tiempo en UTC así como es posible - trabajar con la base de datos hecha por Timetrap sin estropearla. Y muchas pruebas - se han realizado que respaldan esta afirmación. - -Tiempo tiene otras ventajas: - -* Arreglé algunas inconsistencias en el input. -* Resolví algunas incidencias antiguas de Timetrap. -* Las columnas del output están siempre alineadas. -* La interfaz de línea de comandos es más fácil de descubrir (pregunta ``-h`` para cualquier subcomando). -* Los tiempos de conclusión se imprimen con un +1d para indicar que la actividad acabó al siguiente - día. - -Instalación ------------ - -Si tienes instaladas las herramientas de `Rust`_, solo ejecuta: - -.. code:: bash - - cargo install tiempo - -Si usas Arch Linux, instala el paquete `tiempo-git` desde `AUR`_, por ejemplo: - -.. code:: bash - - git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si - -.. NOTE:: - Requieres tener instalado `Rust`_ y `Cargo`_. Para más información haz `clic aquí`_. - -Inicio rápido -------------- - -TODO - -.. _Timetrap: https://github.com/samg/timetrap/ -.. _difícil de instalar: https://github.com/samg/timetrap/issues/176 -.. _actualizado: https://github.com/samg/timetrap/issues/174 -.. _clic aquí: https://doc.rust-lang.org/cargo/getting-started/installation.html -.. _Rust: https://rust-lang.org -.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html -.. _AUR: https://aur.archlinux.org/packages/tiempo-git/ diff --git a/docs/es/source/conf.py b/docs/es/source/conf.py deleted file mode 100644 index cb98caf..0000000 --- a/docs/es/source/conf.py +++ /dev/null @@ -1,62 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - - -# -- Project information ----------------------------------------------------- - -project = 'tiempo' -copyright = '2021, Abraham Toriz' -author = 'Abraham Toriz' - -# The full version, including alpha/beta/rc tags -release = 'v1.1.1' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = 'es' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'alabaster' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/es/source/index.rst b/docs/es/source/index.rst deleted file mode 100644 index e657d44..0000000 --- a/docs/es/source/index.rst +++ /dev/null @@ -1,50 +0,0 @@ -Documentación de Tiempo -======================= - -.. toctree:: - :maxdepth: 2 - :caption: Contenidos: - - basic_usage - advanced_usage - -Tiempo es una herramienta de línea de comandos para rastrear el tiempo. Te ayuda a grabar -el tiempo empleado en diferentes actividades y de manera opcional te permite organizarlas -en proyectos o `sheets` (hojas). Tiempo es compatible con `Timetrap`_, su predecesor. - -Instalación ------------ - -Si tienes instaladas las herramientas de `Rust`_, solo ejecuta: - -.. code:: bash - - cargo install tiempo - -Si usas Arch Linux, instala el paquete `tiempo-git` desde `AUR`_, por ejemplo: - -.. code:: bash - - git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si - -.. NOTE:: - Requieres tener instalado `Rust`_ y `Cargo`_. Para más información haz `clic aquí`_. - -Inicio rápido -------------- - -Ve `aquí`_... - -Agradecimientos especiales --------------------------- - -A `Timetrap`_ por existir y a `samg`_ por hacerlo. Esta herramienta es lo que estaba -buscando y a la que tomé de referencia, manteniendo compatibilidad en lo posible. - -.. _Timetrap: https://github.com/samg/timetrap/ -.. _samg: https://github.com/samg -.. _aquí: basic_usage.html#inicio-rapido -.. _clic aquí: https://doc.rust-lang.org/cargo/getting-started/installation.html -.. _Rust: https://rust-lang.org -.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html -.. _AUR: https://aur.archlinux.org/packages/tiempo-git/ diff --git a/docs/en/make.bat b/docs/make.bat similarity index 95% rename from docs/en/make.bat rename to docs/make.bat index 6fcf05b..747ffb7 100644 --- a/docs/en/make.bat +++ b/docs/make.bat @@ -10,8 +10,6 @@ if "%SPHINXBUILD%" == "" ( set SOURCEDIR=source set BUILDDIR=build -if "%1" == "" goto help - %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. @@ -25,6 +23,8 @@ if errorlevel 9009 ( exit /b 1 ) +if "%1" == "" goto help + %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..4659808 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,28 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Tiempo' +copyright = '2022, Categulario' +author = 'Categulario' +release = '1.4.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..4733cad --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. Tiempo documentation master file, created by + sphinx-quickstart on Sat Sep 17 22:33:18 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Tiempo's documentation! +================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`