diff --git a/Pipfile b/Pipfile index 57fd1a5fcc01f035d3ba07b93193afa8e4a46a58..1e69980e0c15789659bd3183ee7bc0358af7c4c5 100644 --- a/Pipfile +++ b/Pipfile @@ -14,7 +14,7 @@ mkdocs-autorefs = "*" mkdocs-literate-nav = "*" mdx-gh-links = "*" mkdocs-click = "*" -mkdocstrings = {extras = ["python"], version = "*"} +mkdocstrings = { extras = ["python"], version = "*" } setuptools = "*" build = "*" twine = "*" diff --git a/Pipfile.lock b/Pipfile.lock index 151ca70dd65718adfee89aa65e9dc9355668f489..62eebd6073acc76a33b136f434544f020647ee2f 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -18,11 +18,11 @@ "default": { "babel": { "hashes": [ - "sha256:04c3e2d28d2b7681644508f836be388ae49e0cfe91465095340395b60d00f210", - "sha256:fbfcae1575ff78e26c7449136f1abbefc3c13ce542eeb13d43d50d8b047216ec" + "sha256:33e0952d7dd6374af8dbf6768cc4ddf3ccfefc244f9986d4074704f2fbd18900", + "sha256:7077a4984b02b6727ac10f1f7294484f737443d7e2e66c5e4380e41a3ae0b4ed" ], "markers": "python_version >= '3.7'", - "version": "==2.13.0" + "version": "==2.13.1" }, "bracex": { "hashes": [ @@ -50,99 +50,99 @@ }, "charset-normalizer": { "hashes": [ - "sha256:02673e456dc5ab13659f85196c534dc596d4ef260e4d86e856c3b2773ce09843", - "sha256:02af06682e3590ab952599fbadac535ede5d60d78848e555aa58d0c0abbde786", - "sha256:03680bb39035fbcffe828eae9c3f8afc0428c91d38e7d61aa992ef7a59fb120e", - "sha256:0570d21da019941634a531444364f2482e8db0b3425fcd5ac0c36565a64142c8", - "sha256:09c77f964f351a7369cc343911e0df63e762e42bac24cd7d18525961c81754f4", - "sha256:0d3d5b7db9ed8a2b11a774db2bbea7ba1884430a205dbd54a32d61d7c2a190fa", - "sha256:1063da2c85b95f2d1a430f1c33b55c9c17ffaf5e612e10aeaad641c55a9e2b9d", - "sha256:12ebea541c44fdc88ccb794a13fe861cc5e35d64ed689513a5c03d05b53b7c82", - "sha256:153e7b6e724761741e0974fc4dcd406d35ba70b92bfe3fedcb497226c93b9da7", - "sha256:15b26ddf78d57f1d143bdf32e820fd8935d36abe8a25eb9ec0b5a71c82eb3895", - "sha256:1872d01ac8c618a8da634e232f24793883d6e456a66593135aeafe3784b0848d", - "sha256:187d18082694a29005ba2944c882344b6748d5be69e3a89bf3cc9d878e548d5a", - "sha256:1b2919306936ac6efb3aed1fbf81039f7087ddadb3160882a57ee2ff74fd2382", - "sha256:232ac332403e37e4a03d209a3f92ed9071f7d3dbda70e2a5e9cff1c4ba9f0678", - "sha256:23e8565ab7ff33218530bc817922fae827420f143479b753104ab801145b1d5b", - "sha256:24817cb02cbef7cd499f7c9a2735286b4782bd47a5b3516a0e84c50eab44b98e", - "sha256:249c6470a2b60935bafd1d1d13cd613f8cd8388d53461c67397ee6a0f5dce741", - "sha256:24a91a981f185721542a0b7c92e9054b7ab4fea0508a795846bc5b0abf8118d4", - "sha256:2502dd2a736c879c0f0d3e2161e74d9907231e25d35794584b1ca5284e43f596", - "sha256:250c9eb0f4600361dd80d46112213dff2286231d92d3e52af1e5a6083d10cad9", - "sha256:278c296c6f96fa686d74eb449ea1697f3c03dc28b75f873b65b5201806346a69", - "sha256:2935ffc78db9645cb2086c2f8f4cfd23d9b73cc0dc80334bc30aac6f03f68f8c", - "sha256:2f4a0033ce9a76e391542c182f0d48d084855b5fcba5010f707c8e8c34663d77", - "sha256:30a85aed0b864ac88309b7d94be09f6046c834ef60762a8833b660139cfbad13", - "sha256:380c4bde80bce25c6e4f77b19386f5ec9db230df9f2f2ac1e5ad7af2caa70459", - "sha256:3ae38d325b512f63f8da31f826e6cb6c367336f95e418137286ba362925c877e", - "sha256:3b447982ad46348c02cb90d230b75ac34e9886273df3a93eec0539308a6296d7", - "sha256:3debd1150027933210c2fc321527c2299118aa929c2f5a0a80ab6953e3bd1908", - "sha256:4162918ef3098851fcd8a628bf9b6a98d10c380725df9e04caf5ca6dd48c847a", - "sha256:468d2a840567b13a590e67dd276c570f8de00ed767ecc611994c301d0f8c014f", - "sha256:4cc152c5dd831641e995764f9f0b6589519f6f5123258ccaca8c6d34572fefa8", - "sha256:542da1178c1c6af8873e143910e2269add130a299c9106eef2594e15dae5e482", - "sha256:557b21a44ceac6c6b9773bc65aa1b4cc3e248a5ad2f5b914b91579a32e22204d", - "sha256:5707a746c6083a3a74b46b3a631d78d129edab06195a92a8ece755aac25a3f3d", - "sha256:588245972aca710b5b68802c8cad9edaa98589b1b42ad2b53accd6910dad3545", - "sha256:5adf257bd58c1b8632046bbe43ee38c04e1038e9d37de9c57a94d6bd6ce5da34", - "sha256:619d1c96099be5823db34fe89e2582b336b5b074a7f47f819d6b3a57ff7bdb86", - "sha256:63563193aec44bce707e0c5ca64ff69fa72ed7cf34ce6e11d5127555756fd2f6", - "sha256:67b8cc9574bb518ec76dc8e705d4c39ae78bb96237cb533edac149352c1f39fe", - "sha256:6a685067d05e46641d5d1623d7c7fdf15a357546cbb2f71b0ebde91b175ffc3e", - "sha256:70f1d09c0d7748b73290b29219e854b3207aea922f839437870d8cc2168e31cc", - "sha256:750b446b2ffce1739e8578576092179160f6d26bd5e23eb1789c4d64d5af7dc7", - "sha256:7966951325782121e67c81299a031f4c115615e68046f79b85856b86ebffc4cd", - "sha256:7b8b8bf1189b3ba9b8de5c8db4d541b406611a71a955bbbd7385bbc45fcb786c", - "sha256:7f5d10bae5d78e4551b7be7a9b29643a95aded9d0f602aa2ba584f0388e7a557", - "sha256:805dfea4ca10411a5296bcc75638017215a93ffb584c9e344731eef0dcfb026a", - "sha256:81bf654678e575403736b85ba3a7867e31c2c30a69bc57fe88e3ace52fb17b89", - "sha256:82eb849f085624f6a607538ee7b83a6d8126df6d2f7d3b319cb837b289123078", - "sha256:85a32721ddde63c9df9ebb0d2045b9691d9750cb139c161c80e500d210f5e26e", - "sha256:86d1f65ac145e2c9ed71d8ffb1905e9bba3a91ae29ba55b4c46ae6fc31d7c0d4", - "sha256:86f63face3a527284f7bb8a9d4f78988e3c06823f7bea2bd6f0e0e9298ca0403", - "sha256:8eaf82f0eccd1505cf39a45a6bd0a8cf1c70dcfc30dba338207a969d91b965c0", - "sha256:93aa7eef6ee71c629b51ef873991d6911b906d7312c6e8e99790c0f33c576f89", - "sha256:96c2b49eb6a72c0e4991d62406e365d87067ca14c1a729a870d22354e6f68115", - "sha256:9cf3126b85822c4e53aa28c7ec9869b924d6fcfb76e77a45c44b83d91afd74f9", - "sha256:9fe359b2e3a7729010060fbca442ca225280c16e923b37db0e955ac2a2b72a05", - "sha256:a0ac5e7015a5920cfce654c06618ec40c33e12801711da6b4258af59a8eff00a", - "sha256:a3f93dab657839dfa61025056606600a11d0b696d79386f974e459a3fbc568ec", - "sha256:a4b71f4d1765639372a3b32d2638197f5cd5221b19531f9245fcc9ee62d38f56", - "sha256:aae32c93e0f64469f74ccc730a7cb21c7610af3a775157e50bbd38f816536b38", - "sha256:aaf7b34c5bc56b38c931a54f7952f1ff0ae77a2e82496583b247f7c969eb1479", - "sha256:abecce40dfebbfa6abf8e324e1860092eeca6f7375c8c4e655a8afb61af58f2c", - "sha256:abf0d9f45ea5fb95051c8bfe43cb40cda383772f7e5023a83cc481ca2604d74e", - "sha256:ac71b2977fb90c35d41c9453116e283fac47bb9096ad917b8819ca8b943abecd", - "sha256:ada214c6fa40f8d800e575de6b91a40d0548139e5dc457d2ebb61470abf50186", - "sha256:b09719a17a2301178fac4470d54b1680b18a5048b481cb8890e1ef820cb80455", - "sha256:b1121de0e9d6e6ca08289583d7491e7fcb18a439305b34a30b20d8215922d43c", - "sha256:b3b2316b25644b23b54a6f6401074cebcecd1244c0b8e80111c9a3f1c8e83d65", - "sha256:b3d9b48ee6e3967b7901c052b670c7dda6deb812c309439adaffdec55c6d7b78", - "sha256:b5bcf60a228acae568e9911f410f9d9e0d43197d030ae5799e20dca8df588287", - "sha256:b8f3307af845803fb0b060ab76cf6dd3a13adc15b6b451f54281d25911eb92df", - "sha256:c2af80fb58f0f24b3f3adcb9148e6203fa67dd3f61c4af146ecad033024dde43", - "sha256:c350354efb159b8767a6244c166f66e67506e06c8924ed74669b2c70bc8735b1", - "sha256:c5a74c359b2d47d26cdbbc7845e9662d6b08a1e915eb015d044729e92e7050b7", - "sha256:c71f16da1ed8949774ef79f4a0260d28b83b3a50c6576f8f4f0288d109777989", - "sha256:d47ecf253780c90ee181d4d871cd655a789da937454045b17b5798da9393901a", - "sha256:d7eff0f27edc5afa9e405f7165f85a6d782d308f3b6b9d96016c010597958e63", - "sha256:d97d85fa63f315a8bdaba2af9a6a686e0eceab77b3089af45133252618e70884", - "sha256:db756e48f9c5c607b5e33dd36b1d5872d0422e960145b08ab0ec7fd420e9d649", - "sha256:dc45229747b67ffc441b3de2f3ae5e62877a282ea828a5bdb67883c4ee4a8810", - "sha256:e0fc42822278451bc13a2e8626cf2218ba570f27856b536e00cfa53099724828", - "sha256:e39c7eb31e3f5b1f88caff88bcff1b7f8334975b46f6ac6e9fc725d829bc35d4", - "sha256:e46cd37076971c1040fc8c41273a8b3e2c624ce4f2be3f5dfcb7a430c1d3acc2", - "sha256:e5c1502d4ace69a179305abb3f0bb6141cbe4714bc9b31d427329a95acfc8bdd", - "sha256:edfe077ab09442d4ef3c52cb1f9dab89bff02f4524afc0acf2d46be17dc479f5", - "sha256:effe5406c9bd748a871dbcaf3ac69167c38d72db8c9baf3ff954c344f31c4cbe", - "sha256:f0d1e3732768fecb052d90d62b220af62ead5748ac51ef61e7b32c266cac9293", - "sha256:f5969baeaea61c97efa706b9b107dcba02784b1601c74ac84f2a532ea079403e", - "sha256:f8888e31e3a85943743f8fc15e71536bda1c81d5aa36d014a3c0c44481d7db6e", - "sha256:fc52b79d83a3fe3a360902d3f5d79073a993597d48114c29485e9431092905d8" + "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027", + "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087", + "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786", + "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8", + "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09", + "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185", + "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574", + "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e", + "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519", + "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898", + "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269", + "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3", + "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f", + "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6", + "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8", + "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a", + "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73", + "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc", + "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714", + "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2", + "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc", + "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce", + "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d", + "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e", + "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6", + "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269", + "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96", + "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d", + "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a", + "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4", + "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77", + "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d", + "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0", + "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed", + "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068", + "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac", + "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25", + "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8", + "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab", + "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26", + "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2", + "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db", + "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f", + "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5", + "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99", + "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c", + "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d", + "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811", + "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa", + "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a", + "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03", + "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b", + "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04", + "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c", + "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001", + "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458", + "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389", + "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99", + "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985", + "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537", + "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238", + "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f", + "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d", + "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796", + "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a", + "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143", + "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8", + "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c", + "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5", + "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5", + "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711", + "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4", + "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6", + "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c", + "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7", + "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4", + "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b", + "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae", + "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12", + "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c", + "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae", + "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8", + "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887", + "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b", + "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4", + "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f", + "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5", + "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33", + "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519", + "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561" ], "markers": "python_full_version >= '3.7.0'", - "version": "==3.3.0" + "version": "==3.3.2" }, "click": { "hashes": [ @@ -157,7 +157,7 @@ "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6" ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6'", + "markers": "os_name == 'nt'", "version": "==0.4.6" }, "docutils": { @@ -177,27 +177,27 @@ }, "gitdb": { "hashes": [ - "sha256:6eb990b69df4e15bad899ea868dc46572c3f75339735663b81de79b06f17eb9a", - "sha256:c286cf298426064079ed96a9e4a9d39e7f3e9bf15ba60701e95f5492f28415c7" + "sha256:81a3407ddd2ee8df444cbacea00e2d038e40150acfa3001696fe0dcf1d3adfa4", + "sha256:bf5421126136d6d0af55bc1e7c1af1c397a34f5b7bd79e776cd3e89785c2b04b" ], "markers": "python_version >= '3.7'", - "version": "==4.0.10" + "version": "==4.0.11" }, "gitpython": { "hashes": [ - "sha256:5f4c4187de49616d710a77e98ddf17b4782060a1788df441846bddefbb89ab33", - "sha256:f9b9ddc0761c125d5780eab2d64be4873fc6817c2899cbcb34b02344bdc7bc54" + "sha256:22b126e9ffb671fdd0c129796343a02bf67bf2994b35449ffc9321aa755e18a4", + "sha256:cf14627d5a8049ffbf49915732e5eddbe8134c3bdb9d476e6182b676fc573f8a" ], "markers": "python_version >= '3.7'", - "version": "==3.1.37" + "version": "==3.1.40" }, "griffe": { "hashes": [ - "sha256:62af1ca94a5ac73259278b7692d300bf1c6bd8f9beeabaeaa229009bb82d09c6", - "sha256:b8a672c54b99e958b985b3cfbf1de09e25d686dd8a667aa5ec2d0b1601a542fc" + "sha256:7874febe7cd81e8e47eb7b8130ff9d38c8f3656233c01d2d217d2e898a0925f5", + "sha256:b4e510bf0ed1fc91c58453c68018a2247c561adec8f5dadc40275afc01f51eac" ], "markers": "python_version >= '3.8'", - "version": "==0.36.5" + "version": "==0.36.9" }, "idna": { "hashes": [ @@ -241,11 +241,11 @@ }, "markdown": { "hashes": [ - "sha256:4afb124395ce5fc34e6d9886dab977fd9ae987fc6e85689f08278cf0c69d4bf3", - "sha256:a807eb2e4778d9156c8f07876c6e4d50b5494c5665c4834f67b06459dfd877b3" + "sha256:5874b47d4ee3f0b14d764324d2c94c03ea66bee56f2d929da9f2508d65e722dc", + "sha256:b65d7beb248dc22f2e8a31fb706d93798093c308dc1aba295aedeb9d41a813bd" ], "markers": "python_version >= '3.8'", - "version": "==3.5" + "version": "==3.5.1" }, "markdown-it-py": { "hashes": [ @@ -363,11 +363,11 @@ }, "mkdocs-callouts": { "hashes": [ - "sha256:0ab091d1bf0463c5f4f8aef66c60f4768062c37b8db374045d708d73ab41f2cd", - "sha256:a7a8bf35d7fa1a34bc675824b7a03695fed95b65cca2a72327c6074c74d776e8" + "sha256:0fb0472d9f9453ece20a7ed85f4d2dedb91b61bd64a28eea863966349826d31f", + "sha256:cf29b2d36ac994c1999ebc50ac8a3edefc7f7e28b88a3fbf3a8676f9d6822c89" ], "index": "pypi", - "version": "==1.9.1" + "version": "==1.10.0" }, "mkdocs-click": { "hashes": [ @@ -379,19 +379,19 @@ }, "mkdocs-git-revision-date-localized-plugin": { "hashes": [ - "sha256:540b9c930d8d48630c090b72ac2c3900ac2ed0799b23738a33b88e31f5198fe7", - "sha256:7752edd7c4dcaa9383e9a5b6a4f729831a62d604b0c43b319331127720c6a2bf" + "sha256:d57dc99d67af917899e69c392f1ebccd1779fa243d641255469b03f8a3596b96", + "sha256:fc5b23a9d572cbba0114e9e17152001d01724990cb308830e58291fa614faf73" ], "index": "pypi", - "version": "==1.2.0" + "version": "==1.2.1" }, "mkdocs-include-markdown-plugin": { "hashes": [ - "sha256:cbb71f06bf6bd03312f0ff79e1aed198ad13c0ff4fcaf5bb7fe5da385fba4849", - "sha256:eb8832b36a72c1c416baec666eeed057c2e613e8b07b353e86fa518157858b0a" + "sha256:8f9262cf4246ebc33dcdfbdb40c1253b7c9ad79e0f8dc2a9e338b1fb761d8e02", + "sha256:9799ea8ac9179e9e91ab58869421be60a2585e3d9c4a53181d37a49d9a1780db" ], "index": "pypi", - "version": "==6.0.1" + "version": "==6.0.3" }, "mkdocs-literate-nav": { "hashes": [ @@ -497,11 +497,11 @@ }, "pymdown-extensions": { "hashes": [ - "sha256:77a82c621c58a83efc49a389159181d570e370fff9f810d3a4766a75fc678b66", - "sha256:94a0d8a03246712b64698af223848fd80aaf1ae4c4be29c8c61939b0467b5722" + "sha256:8cba67beb2a1318cdaf742d09dff7c0fc4cafcc290147ade0f8fb7b71522711a", + "sha256:f6c79941498a458852853872e379e7bab63888361ba20992fc8b4f8a9b61735e" ], "index": "pypi", - "version": "==10.3" + "version": "==10.3.1" }, "pyproject-hooks": { "hashes": [ @@ -526,6 +526,14 @@ ], "version": "==2023.3.post1" }, + "pywin32-ctypes": { + "hashes": [ + "sha256:3426e063bdd5fd4df74a14fa3cf80a0b42845a87e1d1e81f6549f9daec593a60", + "sha256:bf490a1a709baf35d688fe0ecf980ed4de11d2b3e37b51e5442587a75d9957e7" + ], + "markers": "sys_platform == 'win32'", + "version": "==0.2.2" + }, "pyyaml": { "hashes": [ "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5", @@ -654,6 +662,14 @@ "markers": "python_version >= '3.7'", "version": "==5.0.1" }, + "tomli": { + "hashes": [ + "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc", + "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f" + ], + "markers": "python_version < '3.11'", + "version": "==2.0.1" + }, "twine": { "hashes": [ "sha256:929bc3c280033347a00f847236564d1c52a3e61b1ac2516c97c48f3ceab756d8", @@ -664,11 +680,11 @@ }, "urllib3": { "hashes": [ - "sha256:7a7c7003b000adf9e7ca2a377c9688bbc54ed41b985789ed576570342a375cd2", - "sha256:b19e1a85d206b56d7df1d5e683df4a7725252a964e3993648dd0fb5a1c157564" + "sha256:c97dfde1f7bd43a71c8d2a58e369e9b2bf692d1334ea9f9cae55add7d0dd0f84", + "sha256:fdb6d215c776278489906c2f8916e6e7d4f5a9b602ccbcfdf7f016fc8da0596e" ], "markers": "python_version >= '3.7'", - "version": "==2.0.6" + "version": "==2.0.7" }, "watchdog": { "hashes": [ @@ -713,11 +729,11 @@ }, "wheel": { "hashes": [ - "sha256:0c5ac5ff2afb79ac23ab82bab027a0be7b5dbcf2e54dc50efe4bf507de1f7985", - "sha256:75909db2664838d015e3d9139004ee16711748a52c8f336b52882266540215d8" + "sha256:488609bc63a29322326e05560731bf7bfea8e48ad646e1f5e40d366607de0942", + "sha256:4d4987ce51a49370ea65c0bfd2234e8ce80a12780820d9dc462597a6e60d0841" ], "index": "pypi", - "version": "==0.41.2" + "version": "==0.41.3" }, "zipp": { "hashes": [ diff --git a/README.md b/README.md index 6ccb71496beb958b0911577755305abc90ae45bd..ff39fa6ca1e94a52b302a7a513fcd5c7a27a0f16 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ # Thème DSFR pour MkDocs DSFR -> ATTENTION : Ce thème est uniquement destiné à être utilisé pour les sites et applications officiels des services publics français. Son objectif principal est de faciliter l'identification des sites gouvernementaux pour les citoyens. +> ATTENTION : Ce thème est uniquement destiné à être utilisé pour les sites et applications officiels des services +> publics français. Son objectif principal est de faciliter l'identification des sites gouvernementaux pour les citoyens. [Mentions légales](https://www.systeme-de-design.gouv.fr/cgu/). ## Démarrage rapide -Pour expérimenter rapidement mkdocs avec le DSFR, vous pouvez cloner le [projet d'exemple](https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr-exemple). - +Pour expérimenter rapidement mkdocs avec le DSFR, vous pouvez cloner +le [projet d'exemple](https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr-exemple). ## Configuration du dépôt et des liens d'édition -Dans le fichier `mkdocs.yml`, trois configurations importantes sont définies pour permettre aux utilisateurs de naviguer vers le dépôt source et d'éditer les pages directement : +Dans le fichier `mkdocs.yml`, trois configurations importantes sont définies pour permettre aux utilisateurs de naviguer +vers le dépôt source et d'éditer les pages directement : * `repo_url`: URL du dépôt Git où le code source de la documentation est hébergé. * `edit_uri`: Chemin relatif vers le dossier contenant les fichiers Markdown de la documentation dans le dépôt Git. @@ -31,21 +33,24 @@ Dans ce projet, les configurations sont définies comme suit : Si l'une de ces variables n'est pas remplie, le lien d'édition n'apparaîtra pas. - ## Configuration du thème DSFR MkDocs Ce document décrit les différentes options de configuration pour le thème DSFR MkDocs. Dans votre fichier de configuration `mkdocs.yml`, vous pouvez définir les options de thème pour personnaliser -votre site en utilisant l'exemple suivant : +votre site. Voici les options de thème disponibles et leurs valeurs par défaut : ```yaml theme: - menulateral: true - button_edit_label: "Modifier la page" - intitule: "Intitulé" + # Config par défaut (modifiable) include_search_page: true - show_revision_date: true + afficher_date_de_revision: true + afficher_menu_lateral: true + afficher_bouton_editer: true + libelle_bouton_editer: Éditer dans Gitlab Forge + + # Ces valeurs sont à modifier + intitule: "République <br> française" header: titre: "Titre" sous_titre: "Sous-titre" @@ -60,43 +65,47 @@ theme: url: https://service-public.fr - name: data.gouv.fr url: https://data.gouv.fr + ``` ## Options de Thème ### `name` -Le nom du thème. Il doit être défini sur 'mkdocs'. +Le nom du thème. Il doit être défini sur 'dsfr'. ### `locale` La locale pour le thème. Il est défini sur 'fr' pour le français. -### `custom_dir` +### `include_search_page` -Le répertoire du thème personnalisé. Il doit être défini sur 'dsfr/'. +Permet l'affichage et l'utilisation de la barre de recherche. -### `button_edit_label` +### `afficher_date_de_revision` -Permet de personnaliser le libellé de bouton de modification. +Permet d'afficher la date de dernière révision git. +Valeur booléenne qui permet d'afficher ou de masquer la date de la dernière révision de la page actuelle dans le pied de +page. Vous pouvez la définir sur `true` pour afficher la date, ou sur `false` pour la masquer. +Il est important de noter qu'en plus d'utiliser cette option, vous devez également installer le +plugin `mkdocs-git-revision-date-localized-plugin` pour que cela fonctionne. +`pip install mkdocs-git-revision-date-localized-plugin` -### `menulateral` +### `afficher_menu_lateral` Valeur booléenne pour afficher ou masquer le menu latéral. Définissez-le sur `true` ou `false`. -### `intitule` +### `afficher_bouton_editer` -Cette option définit le titre principal dans l'en-tête et le pied de page. +Valeur booléenne pour afficher ou masquer le menu latéral. Définissez-le sur `true` ou `false`. -### `include_search_page` +### `libelle_bouton_editer` -Valeur booléenne pour afficher ou masquer la barre de recherche dans l'en-tête. Définissez-le sur `true` ou `false`. +Permet de personnaliser le libellé de bouton d'édition. -### `show_revision_date` +### `intitule` -Valeur booléenne qui permet d'afficher ou de masquer la date de la dernière révision de la page actuelle dans le pied de page. Vous pouvez la définir sur `true` pour afficher la date, ou sur `false` pour la masquer. -Il est important de noter qu'en plus d'utiliser cette option, vous devez également installer le plugin `mkdocs-git-revision-date-localized-plugin` pour que cela fonctionne. -`pip install mkdocs-git-revision-date-localized-plugin` +Cette option définit le titre principal du logo dans l'en-tête et le pied de page. ## Options d'En-tête diff --git a/docs/getting-started.md b/docs/getting-started.md index 33b758d16ba2c5c06bbff23d27884877ded7b674..0a2df3cda307c7d303a3f5217b2458c3745abd3d 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -21,7 +21,9 @@ def foo(bar): ## Installation -To install MkDocs, run the following command from the command line: +> To install MkDocs, run the following command from the command line: +> line 2 +> line 3 ```bash pip install mkdocs diff --git a/docs/index.md b/docs/index.md index 724c4a366f07c61949de9999b471b36679545f70..f2fe487adaa30bf0d20c96be7017405c9a0526ba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,6 @@ # MkDocs Project documentation with Markdown. - --- MkDocs is a **fast**, **simple** and **downright gorgeous** static site diff --git a/dsfr/base.html b/dsfr/base.html index 6b86287875f811a33497527f5e94f7082aaf3c1c..2dff97754fc7d39ac362740e25ba97de857cc3b2 100644 --- a/dsfr/base.html +++ b/dsfr/base.html @@ -45,7 +45,7 @@ <main id="content" role="main"> <div class="fr-container markdown-content"> <div class="fr-grid-row"> - {% if config.theme.menulateral %} + {% if config.theme.afficher_menu_lateral %} {% include "lateral.html" %} <div id="contenu" class="fr-col-12 fr-col-md-9 fr-py-12v"> {% else %} @@ -149,7 +149,7 @@ Docs Build Date UTC : {{ build_date_utc }}--> <!-- Script en version es6 module et nomodule pour les navigateurs le ne supportant pas --> -{% if config.theme.show_revision_date %} +{% if config.theme.afficher_date_de_revision %} <div class="revision-date"> {% if page and page.meta and page.meta.git_revision_date_localized %} Dernière révision le {{ page.meta.git_revision_date_localized }} diff --git a/dsfr/css/theme.css b/dsfr/css/theme.css index f7abccdfcb8c49da8f0d2b327184ee7d92f3b47c..4504b44a9bd86e62eccf8b325434eef1ef91dcba 100644 --- a/dsfr/css/theme.css +++ b/dsfr/css/theme.css @@ -12,7 +12,7 @@ h4 { h1:hover .headerlink::before, h2:hover .headerlink::before { - content: url(../dsfr/icons/business/links-line.svg); + content: url(../icons/business/links-line.svg); filter: invert(55%) sepia(89%) saturate(3378%) hue-rotate(217deg) brightness(109%) contrast(93%); } @@ -190,42 +190,42 @@ table { margin-bottom: 25px; } -thead { - --idle: transparent; - --hover: var(--background-contrast-grey-hover); - --active: var(--background-contrast-grey-active); - background-color: var(--background-contrast-grey); - background-image: linear-gradient(0deg, var(--border-plain-grey), var(--border-plain-grey)); - background-position: bottom; - background-repeat: no-repeat; - background-size: 100% 2px; - color: var(--text-title-grey); -} +/*thead {*/ +/* --idle: transparent;*/ +/* --hover: var(--background-contrast-grey-hover);*/ +/* --active: var(--background-contrast-grey-active);*/ +/* background-color: var(--background-contrast-grey);*/ +/* background-image: linear-gradient(0deg, var(--border-plain-grey), var(--border-plain-grey));*/ +/* background-position: bottom;*/ +/* background-repeat: no-repeat;*/ +/* background-size: 100% 2px;*/ +/* color: var(--text-title-grey);*/ +/*}*/ -tbody { - --idle: transparent; - --hover: var(--background-alt-grey-hover); - --active: var(--background-alt-grey-active); - background-color: var(--background-alt-grey); -} +/*tbody {*/ +/* --idle: transparent;*/ +/* --hover: var(--background-alt-grey-hover);*/ +/* --active: var(--background-alt-grey-active);*/ +/* background-color: var(--background-alt-grey);*/ +/*}*/ -tbody tr:nth-child(2n) { - --idle: transparent; - --hover: var(--background-contrast-grey-hover); - --active: var(--background-contrast-grey-active); - background-color: var(--background-contrast-grey); -} +/*tbody tr:nth-child(2n) {*/ +/* --idle: transparent;*/ +/* --hover: var(--background-contrast-grey-hover);*/ +/* --active: var(--background-contrast-grey-active);*/ +/* background-color: var(--background-contrast-grey);*/ +/*}*/ -td, -th { - border: 0; - display: table-cell; - font-size: .875rem; - line-height: 1.5rem; - padding: 0.75rem; - text-align: left; - vertical-align: middle; -} +/*td,*/ +/*th {*/ +/* border: 0;*/ +/* display: table-cell;*/ +/* font-size: .875rem;*/ +/* line-height: 1.5rem;*/ +/* padding: 0.75rem;*/ +/* text-align: left;*/ +/* vertical-align: middle;*/ +/*}*/ .revision-date { text-align: center; diff --git a/dsfr/header.html b/dsfr/header.html index 7265478ad287e249481ac7cc29cea0db688e74ae..1917cf21add6c3b9e1ffd6fc51761bbac9313fc1 100644 --- a/dsfr/header.html +++ b/dsfr/header.html @@ -5,7 +5,7 @@ <div class="fr-header__brand fr-enlarge-link"> <div class="fr-header__brand-top"> <div class="fr-header__logo"> - <p class="fr-logo"> + <p class="fr-logo" style=""> {{ config.theme.intitule }} </p> </div> diff --git a/dsfr/mkdocs_theme.yml b/dsfr/mkdocs_theme.yml index e5da25d2e630202c8aa784bd8bfa7d515468e2ff..48f90a3e8eec0fd54c1a4511d56539f63a237356 100644 --- a/dsfr/mkdocs_theme.yml +++ b/dsfr/mkdocs_theme.yml @@ -1,5 +1,23 @@ -# The theme configuration file -# Defines custom settings specific to this theme. - -# Instructs the search plugin to include the search.html template +# Config par défaut include_search_page: true +afficher_date_de_revision: true +afficher_menu_lateral: true +afficher_bouton_editer: true +libelle_bouton_editer: Éditer dans Gitlab Forge + +# Config à Overrider +intitule: "République <br> française" +header: + titre: "Titre" + sous_titre: "Sous-titre" +footer: + description: "Description à modifier" + links: + - name: legifrance.gouv.fr + url: https://legifrance.gouv.fr + - name: gouvernement.fr + url: https://gouvernement.fr + - name: service-public.fr + url: https://service-public.fr + - name: data.gouv.fr + url: https://data.gouv.fr diff --git a/dsfr/nav.html b/dsfr/nav.html index 779020f0714e4daa9a689bb33695b26595cea5ae..9588b85b90dc10b45332f7b707288662c1114887 100644 --- a/dsfr/nav.html +++ b/dsfr/nav.html @@ -21,9 +21,9 @@ {% endif %} {% endfor %} </ul> - {% if page.file and config.repo_url and config.edit_uri %} + {% if page.file and config.repo_url and config.edit_uri and config.theme.afficher_bouton_editer %} <a href="{{ config.repo_url }}{{ config.edit_uri }}{{ page.file.src_path }}" target="_blank" rel="noopener"> - {{ config.theme.button_edit_label }} + {{ config.theme.libelle_bouton_editer }} </a> {% endif %} diff --git a/mkdocs.yml b/mkdocs.yml index 2bf6c27735063291adf42f03361dd3c46723d68e..7f1e0bc7f3ddaf9192122fe3a1420d49f0f0a48a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,86 +6,68 @@ site_author: MkDocs Team repo_url: https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr/ edit_uri: blob/main/docs/ - theme: - name: mkdocs - button_edit_label: Éditer dans Gitlab Forge - locale: fr - custom_dir: 'dsfr/' - menulateral: true - intitule: "Intitulé" - include_search_page: true - show_revision_date: true - header: - titre: "Titre" - sous_titre: "Sous-titre" - footer: - description: "Description à modifier" - links: - - name: legifrance.gouv.fr - url: https://legifrance.gouv.fr - - name: gouvernement.fr - url: https://gouvernement.fr - - name: service-public.fr - url: https://service-public.fr - - name: data.gouv.fr - url: https://data.gouv.fr - + name: dsfr + locale: fr + intitule: "République <br> française" + header: + titre: "MKDOCS" + sous_titre: "Exemple de documentation" nav: - - Home: index.md - - Getting Started: getting-started.md - - User Guide: user-guide/ - - Developer Guide: dev-guide/ - - About: - - Release Notes: about/release-notes.md - - Contributing: about/contributing.md - - License: about/license.md + - Home: index.md + - Getting Started: getting-started.md + - User Guide: user-guide/ + - Developer Guide: dev-guide/ + - About: + - Release Notes: about/release-notes.md + - Contributing: about/contributing.md + - License: about/license.md extra_css: - - css/extra.css + - css/extra.css markdown_extensions: - - toc: - permalink: "" - - attr_list - - def_list - - tables - - pymdownx.highlight: - use_pygments: true - - pymdownx.snippets - - pymdownx.inlinehilite - - pymdownx.superfences - - mdx_gh_links: - user: mkdocs - repo: mkdocs - - mkdocs-click + - dsfr_blockquote + - dsfr_table + - toc: + permalink: "" + - attr_list + - def_list + - tables + - pymdownx.highlight: + use_pygments: true + - pymdownx.snippets + - pymdownx.superfences + - mdx_gh_links: + user: mkdocs + repo: mkdocs + - mkdocs-click copyright: Copyright © 2014 <a href="https://twitter.com/_tomchristie">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs Team</a>. plugins: - - search: - lang: fr - - callouts - - redirects: - redirect_maps: - user-guide/plugins.md: dev-guide/plugins.md - user-guide/custom-themes.md: dev-guide/themes.md - user-guide/styling-your-docs.md: user-guide/choosing-your-theme.md - - autorefs - - literate-nav: - nav_file: README.md - implicit_index: true - - mkdocstrings: - handlers: - python: - options: - docstring_section_style: list - members_order: source - show_root_heading: true - show_source: false - show_signature_annotations: true - - git-revision-date-localized + - search: + lang: fr + - redirects: + redirect_maps: + user-guide/plugins.md: dev-guide/plugins.md + user-guide/custom-themes.md: dev-guide/themes.md + user-guide/styling-your-docs.md: user-guide/choosing-your-theme.md + - autorefs + - literate-nav: + nav_file: README.md + implicit_index: true + - mkdocstrings: + handlers: + python: + options: + docstring_section_style: list + members_order: source + show_root_heading: true + show_source: false + show_signature_annotations: true + - git-revision-date-localized watch: - - mkdocs + - mkdocs diff --git a/pyproject.toml b/pyproject.toml index 2dd3edc6041d34a64e80017f1efbd08f24726a1b..0b182c457334bc26f03476755f6c8f43591e4a2a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,17 +1,16 @@ - [project] name = "mkdocs-dsfr" version = "0.7.0" description = "DSFR theme for Mkdocs" readme = "README.md" authors = [ - {name = "Ministère Transition Écologique - DNUM", email = "numerique-ecologie@developpement-durable.gouv.fr"}, + { name = "Ministère Transition Écologique - DNUM", email = "numerique-ecologie@developpement-durable.gouv.fr" }, ] requires-python = ">=3.7" dependencies = [ "mkdocs>=1.4", ] -license = {text = "MIT"} +license = { text = "MIT" } [project.urls] Homepage = "https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr" @@ -21,10 +20,15 @@ dsfr = "dsfr" [build-system] requires = [ - "setuptools", - "wheel" + "setuptools", + "wheel" ] build-backend = "setuptools.build_meta" [tool.setuptools] -packages = ["dsfr"] \ No newline at end of file +packages = ["dsfr"] + +[options.entry_points] +"mkdocs.plugins" = [ + "hello = hello:Hello" +]