diff --git a/README.md b/README.md index 0eeb7ae87..acb71a004 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -

nerfactory🤘

+

+ +

The all-in-one repo for NeRFs

diff --git a/docs/_static/imgs/logo-dark.png b/docs/_static/imgs/logo-dark.png new file mode 100644 index 000000000..727b75104 Binary files /dev/null and b/docs/_static/imgs/logo-dark.png differ diff --git a/docs/_static/imgs/logo.png b/docs/_static/imgs/logo.png new file mode 100644 index 000000000..3695e8311 Binary files /dev/null and b/docs/_static/imgs/logo.png differ diff --git a/docs/_templates/sidebar/brand.html b/docs/_templates/sidebar/brand.html new file mode 100644 index 000000000..e2eb49b42 --- /dev/null +++ b/docs/_templates/sidebar/brand.html @@ -0,0 +1,32 @@ +{#- Hi there! You might be interested in +https://pradyunsg.me/furo/customisation/sidebar/ Although if you're reading +this, chances are that you're either familiar enough with Sphinx that you know +what you're doing, or landed here from that documentation page. Hope your day's +going well. :) -#} + diff --git a/docs/conf.py b/docs/conf.py index 868c5cdcb..a6f8562eb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,21 +76,27 @@ myst_enable_extensions = ["amsmath", "colon_fence", "deflist", "dollarmath", "ht # a list of builtin themes. # html_theme = "furo" -html_title = "nerfactory" +html_title = "" autosectionlabel_prefix_document = True html_theme_options = { "light_css_variables": { - "color-brand-primary": "#00878e", - "color-brand-content": "#00878e", + "color-brand-primary": "#ba3e00", + "color-brand-content": "#ff6f00", }, + "dark_css_variables": { + "color-brand-primary": "#fdd06c", + "color-brand-content": "#ff903b", + }, + "light_logo": "imgs/logo.png", + "dark_logo": "imgs/logo-dark.png", } # -- Code block theme -------------------------------------------------------- -pygments_style = "manni" -pygments_dark_style = "stata-dark" +pygments_style = "one-dark" +pygments_dark_style = "one-dark" # -- Napoleon settings ------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index c7f7ceefc..de8ec602e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,17 @@ -nerfactory |:metal:| -==================================== + +| + +.. image:: _static/imgs/logo.png + :width: 400 + :align: center + :alt: nerfactory Neural Volumetric Rendering """"""""""""""""""""""""""""" All-in-one repository for state-of-the-art NeRFs. -nerfactory |:metal:| provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs. +nerfactory provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs. The library supports a more interpretable implementation of NeRFs by modularizing each component. With more modular NeRFs, not only does your code become far more user-friendly, but using this framework also makes it easier for the community to build upon your implementation. diff --git a/docs/tutorials/quickstart_index.rst b/docs/tutorials/quickstart_index.rst index 0a1067e01..b61c78e15 100644 --- a/docs/tutorials/quickstart_index.rst +++ b/docs/tutorials/quickstart_index.rst @@ -1,12 +1,18 @@ -nerfactory |:metal:| -==================================== + +| + +.. image:: ../_static/imgs/logo.png + :width: 400 + :align: center + :alt: nerfactory + Neural Volumetric Rendering """"""""""""""""""""""""""""" All-in-one repository for state-of-the-art NeRFs. -nerfactory |:metal:| provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs. +nerfactory provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs. The library supports a more interpretable implementation of NeRFs by modularizing each component. With more modular NeRFs, not only does your code become far more user-friendly, but using this framework also makes it easier for the community to build upon your implementation.