diff --git a/.gitignore b/.gitignore index d60aca3..b46ae9b 100644 --- a/.gitignore +++ b/.gitignore @@ -186,4 +186,5 @@ cython_debug/ autosummary/ # Include DMF env module -!dmf/env/ \ No newline at end of file +!dmf/env/ +!docs/assets/*.svg \ No newline at end of file diff --git a/README.md b/README.md index e5c5d9d..4eadb94 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ -# DMF Utils +<p align="center"> + <a href="https://github.com/memory-formation/dmf-utils"> + <picture> + <source media="(prefers-color-scheme: dark)" srcset="./docs/assets/dmf-utils-dark.svg"> + <img alt="dmf-utils" src="./docs/assets/dmf-utils.svg"> + </picture> + </a> +</p> + +------- [](https://pypi.org/project/dmf-utils/)  diff --git a/docs/assets/dmf-utils-dark.svg b/docs/assets/dmf-utils-dark.svg new file mode 100644 index 0000000..fbbea53 --- /dev/null +++ b/docs/assets/dmf-utils-dark.svg @@ -0,0 +1 @@ +<svg width="1320" height="467" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" overflow="hidden"><defs><clipPath id="clip0"><rect x="2328" y="371" width="1320" height="467"/></clipPath><clipPath id="clip1"><rect x="2328" y="456" width="296" height="295"/></clipPath><clipPath id="clip2"><rect x="2328" y="456" width="296" height="295"/></clipPath><clipPath id="clip3"><rect x="2328" y="456" width="296" height="295"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-2328 -371)"><g clip-path="url(#clip1)"><g clip-path="url(#clip2)"><g clip-path="url(#clip3)"><path d="M-0.505154 165.186C-0.505154 158.113-0.505154 151.041-0.505154 143.969 1.34938 140.094 3.37 136.222 5.5567 132.35 3.61265 126.64 1.59203 121.084-0.505154 115.68-0.505154 110.965-0.505154 106.251-0.505154 101.536 4.18328 83.3892 15.9703 73.6228 34.8557 72.2371 35.6555 52.4104 45.7586 40.4551 65.1649 36.3711 70.2165 35.6976 75.268 35.6976 80.3196 36.3711 84.0024 37.549 87.7069 38.2226 91.433 38.3917 95.3211 32.3029 99.6991 26.5779 104.567 21.2165 114.528 14.0103 125.641 11.6529 137.907 14.1443 142.765 15.7293 147.142 18.0867 151.041 21.2165 147.792 27.1653 143.751 32.5537 138.917 37.3814 129.239 41.8428 119.136 44.8737 108.608 46.4742 114.159 52.0294 120.726 55.9022 128.309 58.0928 125.584 69.6676 126.931 80.781 132.35 91.433 134.371 93.4536 136.392 95.4742 138.412 97.4948 132.995 59.3019 148.992 35.8964 186.402 27.2783 227.038 22.8412 251.958 40.5216 261.165 80.3196 277.157 84.8332 285.576 95.4415 286.423 112.144 285.415 120.383 283.226 128.297 279.856 135.887 259.172 120.258 243.344 100.725 232.371 77.2886 231.077 89.7276 233.265 101.515 238.938 112.649 224.874 112.578 210.729 112.745 196.505 113.155 193.093 113.611 189.725 114.284 186.402 115.175 203.365 117.816 219.867 122.195 235.907 128.309 250.84 133.992 262.458 143.59 270.763 157.103 274.13 165.859 274.13 174.615 270.763 183.371 260.865 200.128 249.246 215.619 235.907 229.845 237.896 241.238 240.255 252.519 242.979 263.691 227.19 263.456 215.234 256.553 207.113 242.979 204.24 235.856 200.704 229.121 196.505 222.773 189.802 220.814 183.066 218.961 176.299 217.216 174.558 216.688 173.211 215.678 172.258 214.186 178.12 207.977 183.677 201.41 188.928 194.484 201.473 178.528 217.806 171.624 237.928 173.773 232.77 167.101 225.867 163.902 217.216 164.175 205.434 165.436 194.826 169.646 185.392 176.804 173.604 186.571 161.818 196.336 150.031 206.103 132.544 217.445 115.033 217.445 97.4948 206.103 84.0891 186.466 85.7729 168.28 102.546 151.546 105.74 150.119 108.771 148.435 111.639 146.495 100.738 144.487 89.9618 145.16 79.3093 148.515 77.8637 148.985 76.685 149.828 75.7732 151.041 61.2105 142.273 45.5507 139.411 28.7938 142.454 39.8504 145.236 49.9535 149.95 59.1031 156.598 69.5218 168.132 72.8895 181.434 69.2062 196.505 51.3315 204.879 34.8297 202.69 19.701 189.938 14.4811 184.718 9.26117 179.499 4.04124 174.278 2.22181 171.311 0.706343 168.28-0.505154 165.186Z" fill="#518AC5" fill-rule="evenodd" fill-opacity="0.999" transform="matrix(1.0034 0 0 1 2329 456)"/></g></g></g><text fill="#F2F2F2" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" transform="matrix(1 0 0 1 2638.77 653)">dmf<tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="387.865" y="0">-</tspan><tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="476.094" y="0">utils</tspan><tspan fill="#AFABAB" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="55" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="48.125" y="75">D</tspan><tspan fill="#AFABAB" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="55" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="86.5105" y="75">ynamics of Memory Formation</tspan></text></g></svg> \ No newline at end of file diff --git a/docs/assets/dmf-utils-inline-dark.svg b/docs/assets/dmf-utils-inline-dark.svg new file mode 100644 index 0000000..18f81c4 --- /dev/null +++ b/docs/assets/dmf-utils-inline-dark.svg @@ -0,0 +1 @@ +<svg width="1325" height="468" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" overflow="hidden"><defs><clipPath id="clip0"><rect x="2456" y="1553" width="1325" height="468"/></clipPath><clipPath id="clip1"><rect x="2460" y="1607" width="296" height="295"/></clipPath><clipPath id="clip2"><rect x="2460" y="1607" width="296" height="295"/></clipPath><clipPath id="clip3"><rect x="2460" y="1607" width="296" height="295"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-2456 -1553)"><g clip-path="url(#clip1)"><g clip-path="url(#clip2)"><g clip-path="url(#clip3)"><path d="M2460.49 1772.75C2460.49 1765.65 2460.49 1758.55 2460.49 1751.46 2462.35 1747.57 2464.38 1743.69 2466.58 1739.8 2464.62 1734.07 2462.6 1728.5 2460.49 1723.07 2460.49 1718.34 2460.49 1713.61 2460.49 1708.88 2465.2 1690.67 2477.02 1680.87 2495.97 1679.48 2496.78 1659.59 2506.91 1647.59 2526.39 1643.49 2531.46 1642.82 2536.52 1642.82 2541.59 1643.49 2545.29 1644.68 2549.01 1645.35 2552.74 1645.52 2556.65 1639.41 2561.04 1633.67 2565.92 1628.29 2575.92 1621.06 2587.07 1618.69 2599.38 1621.19 2604.25 1622.78 2608.64 1625.15 2612.55 1628.29 2609.29 1634.26 2605.24 1639.66 2600.39 1644.51 2590.68 1648.99 2580.54 1652.03 2569.98 1653.63 2575.55 1659.21 2582.14 1663.09 2589.75 1665.29 2587.01 1676.9 2588.36 1688.06 2593.8 1698.74 2595.83 1700.77 2597.86 1702.8 2599.88 1704.83 2594.45 1666.5 2610.5 1643.02 2648.04 1634.37 2688.81 1629.92 2713.81 1647.66 2723.05 1687.59 2739.1 1692.12 2747.55 1702.77 2748.4 1719.53 2747.39 1727.79 2745.19 1735.73 2741.81 1743.35 2721.05 1727.67 2705.17 1708.07 2694.16 1684.55 2692.86 1697.03 2695.06 1708.86 2700.75 1720.03 2686.64 1719.96 2672.45 1720.13 2658.17 1720.54 2654.75 1721 2651.37 1721.67 2648.04 1722.57 2665.06 1725.22 2681.62 1729.61 2697.71 1735.75 2712.69 1741.45 2724.35 1751.08 2732.68 1764.64 2736.06 1773.42 2736.06 1782.21 2732.68 1790.99 2722.75 1807.81 2711.09 1823.35 2697.71 1837.63 2699.71 1849.06 2702.07 1860.38 2704.81 1871.59 2688.96 1871.35 2676.97 1864.43 2668.82 1850.81 2665.93 1843.66 2662.39 1836.9 2658.17 1830.53 2651.45 1828.57 2644.69 1826.71 2637.9 1824.96 2636.15 1824.43 2634.8 1823.41 2633.84 1821.91 2639.73 1815.68 2645.3 1809.1 2650.57 1802.15 2663.16 1786.13 2679.55 1779.21 2699.74 1781.36 2694.56 1774.67 2687.64 1771.46 2678.96 1771.73 2667.13 1773 2656.49 1777.22 2647.02 1784.41 2635.19 1794.21 2623.37 1804 2611.54 1813.8 2594 1825.18 2576.42 1825.18 2558.83 1813.8 2545.38 1794.1 2547.06 1775.85 2563.9 1759.06 2567.1 1757.63 2570.14 1755.94 2573.02 1753.99 2562.08 1751.98 2551.27 1752.65 2540.58 1756.02 2539.13 1756.49 2537.95 1757.34 2537.03 1758.55 2522.42 1749.76 2506.71 1746.88 2489.89 1749.94 2500.99 1752.73 2511.12 1757.46 2520.3 1764.13 2530.76 1775.7 2534.14 1789.05 2530.44 1804.17 2512.51 1812.58 2495.95 1810.38 2480.77 1797.58 2475.53 1792.35 2470.29 1787.11 2465.05 1781.87 2463.23 1778.89 2461.71 1775.85 2460.49 1772.75Z" fill="#518AC5" fill-rule="evenodd" fill-opacity="0.999"/></g></g></g><text fill="#F2F2F2" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" transform="matrix(1 0 0 1 2770.48 1837)">dmf<tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="387.865" y="0">-</tspan><tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="476.094" y="0">utils</tspan></text></g></svg> \ No newline at end of file diff --git a/docs/assets/dmf-utils-inline.svg b/docs/assets/dmf-utils-inline.svg new file mode 100644 index 0000000..ef05d1e --- /dev/null +++ b/docs/assets/dmf-utils-inline.svg @@ -0,0 +1 @@ +<svg width="1320" height="467" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" overflow="hidden"><defs><clipPath id="clip0"><rect x="664" y="1485" width="1320" height="467"/></clipPath><clipPath id="clip1"><rect x="665" y="1538" width="296" height="296"/></clipPath><clipPath id="clip2"><rect x="665" y="1538" width="296" height="296"/></clipPath><clipPath id="clip3"><rect x="665" y="1538" width="296" height="296"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-664 -1485)"><g clip-path="url(#clip1)"><g clip-path="url(#clip2)"><g clip-path="url(#clip3)"><path d="M-0.505155 165.186C-0.505155 158.114-0.505155 151.041-0.505155 143.969 1.34938 140.095 3.37 136.222 5.55671 132.351 3.61266 126.64 1.59204 121.084-0.505155 115.681-0.505155 110.965-0.505155 106.251-0.505155 101.536 4.18328 83.3893 15.9703 73.6229 34.8557 72.2372 35.6556 52.4104 45.7587 40.4551 65.165 36.3712 70.2166 35.6976 75.2681 35.6976 80.3197 36.3712 84.0025 37.5491 87.707 38.2227 91.4331 38.3918 95.3213 32.303 99.6992 26.5779 104.567 21.2165 114.528 14.0103 125.641 11.6529 137.907 14.1443 142.765 15.7293 147.143 18.0867 151.041 21.2165 147.792 27.1653 143.751 32.5537 138.918 37.3815 129.239 41.8428 119.136 44.8737 108.608 46.4743 114.159 52.0295 120.726 55.9023 128.309 58.0928 125.585 69.6677 126.931 80.7811 132.351 91.4331 134.371 93.4537 136.392 95.4743 138.412 97.4949 132.995 59.302 148.992 35.8964 186.402 27.2784 227.038 22.8412 251.958 40.5216 261.165 80.3197 277.157 84.8333 285.576 95.4416 286.423 112.144 285.416 120.384 283.226 128.297 279.856 135.887 259.172 120.258 243.344 100.725 232.371 77.2887 231.077 89.7277 233.265 101.515 238.938 112.65 224.874 112.578 210.729 112.746 196.505 113.155 193.094 113.611 189.725 114.284 186.402 115.175 203.365 117.816 219.868 122.195 235.907 128.309 250.84 133.992 262.458 143.59 270.763 157.103 274.13 165.86 274.13 174.615 270.763 183.371 260.865 200.128 249.247 215.619 235.907 229.846 237.897 241.238 240.255 252.519 242.98 263.691 227.19 263.457 215.234 256.553 207.114 242.98 204.24 235.856 200.704 229.121 196.505 222.773 189.802 220.814 183.066 218.962 176.299 217.217 174.558 216.688 173.212 215.678 172.258 214.186 178.121 207.977 183.677 201.41 188.928 194.485 201.473 178.528 217.807 171.624 237.928 173.773 232.77 167.101 225.867 163.903 217.217 164.175 205.434 165.436 194.826 169.646 185.392 176.804 173.605 186.571 161.818 196.337 150.031 206.103 132.545 217.445 115.033 217.445 97.4949 206.103 84.0892 186.466 85.773 168.28 102.546 151.547 105.74 150.119 108.771 148.435 111.639 146.495 100.739 144.487 89.9619 145.16 79.3093 148.516 77.8638 148.985 76.6851 149.828 75.7733 151.041 61.2106 142.273 45.5507 139.411 28.7938 142.454 39.8505 145.236 49.9536 149.95 59.1031 156.598 69.5219 168.132 72.8895 181.435 69.2062 196.505 51.3315 204.879 34.8297 202.69 19.701 189.938 14.4811 184.718 9.26118 179.499 4.04124 174.279 2.22181 171.311 0.706344 168.28-0.505155 165.186Z" fill="#518AC5" fill-rule="evenodd" fill-opacity="0.999" transform="matrix(1 0 0 1.0034 666 1539)"/></g></g></g><text fill="#0D0D0D" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" transform="matrix(1 0 0 1 974.909 1768)">dmf<tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="387.865" y="0">-</tspan><tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="476.094" y="0">utils</tspan></text></g></svg> \ No newline at end of file diff --git a/docs/assets/dmf-utils.svg b/docs/assets/dmf-utils.svg new file mode 100644 index 0000000..14689e5 --- /dev/null +++ b/docs/assets/dmf-utils.svg @@ -0,0 +1 @@ +<svg width="1325" height="468" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" overflow="hidden"><defs><clipPath id="clip0"><rect x="806" y="334" width="1325" height="468"/></clipPath><clipPath id="clip1"><rect x="810" y="421" width="296" height="294"/></clipPath><clipPath id="clip2"><rect x="810" y="421" width="296" height="294"/></clipPath><clipPath id="clip3"><rect x="810" y="421" width="296" height="294"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-806 -334)"><g clip-path="url(#clip1)"><g clip-path="url(#clip2)"><g clip-path="url(#clip3)"><path d="M-0.505154 165.186C-0.505154 158.113-0.505154 151.041-0.505154 143.969 1.34938 140.094 3.37 136.222 5.5567 132.35 3.61265 126.64 1.59203 121.084-0.505154 115.68-0.505154 110.965-0.505154 106.251-0.505154 101.536 4.18328 83.3892 15.9703 73.6228 34.8557 72.2371 35.6555 52.4104 45.7586 40.4551 65.1649 36.3711 70.2165 35.6976 75.268 35.6976 80.3196 36.3711 84.0024 37.549 87.7069 38.2226 91.433 38.3917 95.3211 32.3029 99.6991 26.5779 104.567 21.2165 114.528 14.0103 125.641 11.6529 137.907 14.1443 142.765 15.7293 147.142 18.0867 151.041 21.2165 147.792 27.1653 143.751 32.5537 138.917 37.3814 129.239 41.8428 119.136 44.8737 108.608 46.4742 114.159 52.0294 120.726 55.9022 128.309 58.0928 125.584 69.6676 126.931 80.781 132.35 91.433 134.371 93.4536 136.392 95.4742 138.412 97.4948 132.995 59.3019 148.992 35.8964 186.402 27.2783 227.038 22.8412 251.958 40.5216 261.165 80.3196 277.157 84.8332 285.576 95.4415 286.423 112.144 285.415 120.383 283.226 128.297 279.856 135.887 259.172 120.258 243.344 100.725 232.371 77.2886 231.077 89.7276 233.265 101.515 238.938 112.649 224.874 112.578 210.729 112.745 196.505 113.155 193.093 113.611 189.725 114.284 186.402 115.175 203.365 117.816 219.867 122.195 235.907 128.309 250.84 133.992 262.458 143.59 270.763 157.103 274.13 165.859 274.13 174.615 270.763 183.371 260.865 200.128 249.246 215.619 235.907 229.845 237.896 241.238 240.255 252.519 242.979 263.691 227.19 263.456 215.234 256.553 207.113 242.979 204.24 235.856 200.704 229.121 196.505 222.773 189.802 220.814 183.066 218.961 176.299 217.216 174.558 216.688 173.211 215.678 172.258 214.186 178.12 207.977 183.677 201.41 188.928 194.484 201.473 178.528 217.806 171.624 237.928 173.773 232.77 167.101 225.867 163.902 217.216 164.175 205.434 165.436 194.826 169.646 185.392 176.804 173.604 186.571 161.818 196.336 150.031 206.103 132.544 217.445 115.033 217.445 97.4948 206.103 84.0891 186.466 85.7729 168.28 102.546 151.546 105.74 150.119 108.771 148.435 111.639 146.495 100.738 144.487 89.9618 145.16 79.3093 148.515 77.8637 148.985 76.685 149.828 75.7732 151.041 61.2105 142.273 45.5507 139.411 28.7938 142.454 39.8504 145.236 49.9535 149.95 59.1031 156.598 69.5218 168.132 72.8895 181.434 69.2062 196.505 51.3315 204.879 34.8297 202.69 19.701 189.938 14.4811 184.718 9.26117 179.499 4.04124 174.278 2.22181 171.311 0.706343 168.28-0.505154 165.186Z" fill="#518AC5" fill-rule="evenodd" fill-opacity="0.999" transform="matrix(1.0034 0 0 1 811 421)"/></g></g></g><text fill="#0D0D0D" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" transform="matrix(1 0 0 1 1120.78 617)">dmf<tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="387.865" y="0">-</tspan><tspan fill="#5189C5" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="220" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="476.094" y="0">utils</tspan><tspan fill="#767171" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="55" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="48.125" y="76">D</tspan><tspan fill="#767171" fill-opacity="1" font-family="Segoe UI,Segoe UI_MSFontService,sans-serif" font-style="normal" font-variant="normal" font-weight="400" font-stretch="normal" font-size="55" text-anchor="start" direction="ltr" writing-mode="lr-tb" unicode-bidi="normal" text-decoration="none" x="86.5105" y="76">ynamics of Memory Formation</tspan></text></g></svg> \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 22f72da..de61b48 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,8 +52,6 @@ 'pillow': ('https://pillow.readthedocs.io/en/stable/', None), 'torch': ('https://pytorch.org/docs/stable/', None), 'sklearn': ('https://scikit-learn.org/stable/', None), - 'h5py': ('http://docs.h5py.org/en/stable/', None), - 'joblib': ('https://joblib.readthedocs.io/en/latest/', None), } autodoc_default_options = {"members": True, "inherited-members": True, "show-inheritance": True} @@ -64,7 +62,9 @@ html_theme = "pydata_sphinx_theme" html_favicon = "https://brainvitge.org/website/wp-content/themes/brainvitge/favicon.png" -html_logo = "https://raw.githubusercontent.com/memory-formation/.github/main/logos/brainvitge.png" +#html_logo = "https://raw.githubusercontent.com/memory-formation/.github/main/logos/brainvitge.png" +html_logo = "assets/dmf-utils-inline.svg" +html_logo_dark = "assets/dmf-utils-inline-dark.svg" html_theme_options = { "github_url": "https://github.com/memory-formation/dmf-utils", # "navbar_start": ["navbar-logo"], @@ -84,6 +84,10 @@ "type": "url", }, ], + "logo": { + "image_light": html_logo, + "image_dark": html_logo_dark, + }, } html_context = { "github_user": "memory-formation", diff --git a/docs/index.rst b/docs/index.rst index bfdc31c..c7c9654 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,15 @@ -Welcome to DMF Utils's documentation! -===================================== + + +.. image:: ./assets/dmf-utils.svg + :alt: dmf-utils + :target: https://github.com/memory-formation/dmf-utils/ + :class: only-light + +.. image:: ./assets/dmf-utils-dark.svg + :alt: dmf-utils + :target: https://github.com/memory-formation/dmf-utils/ + :class: only-dark + .. image:: https://badge.fury.io/py/dmf-utils.svg :target: https://pypi.org/project/dmf-utils/