diff --git a/README.md b/README.md index 2dec3d5..a896676 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Right now, the content includes stuff for doing ECT on graphs embedded in 2D. Ev For more information on the ECT, see: -> Elizabeth Munch. An Invitation to the Euler Characteristic Transform. [arXiv:2310.10395](https://arxiv.org/abs/2310.10395). 2023. +> Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. [doi:10.1080/00029890.2024.2409616](https://doi.org/10.1080/00029890.2024.2409616). 2024. ## Getting Started @@ -45,6 +45,7 @@ pip install . This code was written by [Liz Munch](https://elizabethmunch.com/) along with her research group and collaborators. People who have contributed to `ect` include: - [Sarah McGuire](https://www.sarah-mcguire.com/) +- [Yemeen Ayub](https://yemeen.com/) ## License diff --git a/doc_source/citing.rst b/doc_source/citing.rst index f68ddaa..9db2cbb 100644 --- a/doc_source/citing.rst +++ b/doc_source/citing.rst @@ -3,5 +3,5 @@ Citing To cite `ect` please use the following publication: - Elizabeth Munch. An Invitation to the Euler Characteristic Transform. `arXiv:2310.10395 `_. 2023. + Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. `doi:10.1080/00029890.2024.2409616 `_. 2024. diff --git a/doc_source/conf.py b/doc_source/conf.py index 1cc9da8..b1ce869 100644 --- a/doc_source/conf.py +++ b/doc_source/conf.py @@ -24,7 +24,7 @@ # -- Project information ----------------------------------------------------- project = 'ect' -copyright = '2024, MunchLab' +copyright = '2025, MunchLab' author = 'MunchLab' # The full version, including alpha/beta/rc tags @@ -70,12 +70,29 @@ # a list of builtin themes. # html_theme = 'sphinx_rtd_theme' +html_logo = 'img/ECT_Logo.png' +html_favicon = 'img/ECT_Logo_128x128.png' +html_theme_options = { + 'canonical_url': '', + 'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard + 'logo_only': False, + 'display_version': True, + 'prev_next_buttons_location': 'bottom', + 'style_external_links': True, + 'style_nav_header_background': '#cececf', + # Toc options + 'collapse_navigation': False, + 'sticky_navigation': True, + 'navigation_depth': 3, + 'includehidden': True, + 'titles_only': False, +} autodoc_default_options = { 'members': True, 'member-order': 'bysource', 'special-members': '__init__', 'undoc-members': True, - 'exclude-members': '__weakref__' + 'exclude-members': '__weakref__', } numpydoc_show_class_members = False autodoc_typehints = "none" diff --git a/doc_source/img/ECT_Logo.png b/doc_source/img/ECT_Logo.png new file mode 100644 index 0000000..b3bfe44 Binary files /dev/null and b/doc_source/img/ECT_Logo.png differ diff --git a/doc_source/img/ECT_Logo_128x128.png b/doc_source/img/ECT_Logo_128x128.png new file mode 100644 index 0000000..7d5fb2f Binary files /dev/null and b/doc_source/img/ECT_Logo_128x128.png differ diff --git a/doc_source/img/ECT_Logo_150x111.png b/doc_source/img/ECT_Logo_150x111.png new file mode 100644 index 0000000..78bd117 Binary files /dev/null and b/doc_source/img/ECT_Logo_150x111.png differ diff --git a/doc_source/img/ECT_Logo_32x32.png b/doc_source/img/ECT_Logo_32x32.png new file mode 100644 index 0000000..359438d Binary files /dev/null and b/doc_source/img/ECT_Logo_32x32.png differ diff --git a/doc_source/img/ECT_Logo_64x64.png b/doc_source/img/ECT_Logo_64x64.png new file mode 100644 index 0000000..3ee2029 Binary files /dev/null and b/doc_source/img/ECT_Logo_64x64.png differ diff --git a/doc_source/index.rst b/doc_source/index.rst index 4b6839c..d35502e 100644 --- a/doc_source/index.rst +++ b/doc_source/index.rst @@ -25,7 +25,7 @@ Right now, the content includes stuff for doing ECT on graphs embedded in 2D. Ev For more information on the ECT, see: - Elizabeth Munch. An Invitation to the Euler Characteristic Transform. `arXiv:2310.10395 `_. 2023. + Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. `doi:10.1080/00029890.2024.2409616 `_. 2024. Getting Started --------------- @@ -69,6 +69,7 @@ Authors This code was written by `Liz Munch `_ along with her research group and collaborators. People who have contributed to `ect` include: - `Sarah McGuire `_ +- `Yemeen Ayub `_ License ------- diff --git a/docs/.buildinfo b/docs/.buildinfo index d753ef2..c328c0c 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 1dadfd971d70ecf359ab515ba8084b45 +config: 4fa06ba1eba33764a2433ecca7acac59 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_modules/ect/ect_graph.html b/docs/_modules/ect/ect_graph.html index ac9c3d9..61b4eeb 100644 --- a/docs/_modules/ect/ect_graph.html +++ b/docs/_modules/ect/ect_graph.html @@ -1,5 +1,3 @@ - - @@ -7,16 +5,21 @@ ect.ect_graph — ect 0.1.5 documentation - + - - - - - - + + + + + + + + + @@ -26,12 +29,13 @@
-