Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/inject footer #6

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

irfankhan10
Copy link
Collaborator

Injecting react footer in sphinx html template:

image

Comment on lines +9 to +10
renderIn.style.padding = '0'
renderIn.style.margin = '0'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this needed?

@@ -0,0 +1,18 @@
@echo off
Copy link
Collaborator

@aidanCQ aidanCQ Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should install git and use bash to run the shell script. Most devs work on linux or MacOS and I'd consider a batch file to be non-standard.

call npm run build
echo "Copying UI assets to dist..."
copy /y /v .\build\injectNav.global.js ..\dist\_static\injectNav.global.js
copy /y /v .\build\injectFooter.global.js ..\dist\_static\injectFooter.global.js
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This addition is missing in build-dist.sh. Keeping the build logic to one file should prevent this drift.

Comment on lines -234 to -247
{% trans %}Made with {% endtrans -%}
{%- if show_sphinx -%}
{% trans %}<a href="https://www.sphinx-doc.org/">Sphinx</a> and {% endtrans -%}
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
{% endif -%}
{% trans %}
<a href="https://github.com/pradyunsg/furo">Furo</a>
{% endtrans %}

{%- if last_updated -%}
<div class="last-updated">
{% trans last_updated=last_updated|e -%}
Last updated on {{ last_updated }}
{%- endtrans -%}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would leave all the default content as is, apart from things we are making custom. It makes it clearer what we have modified vs what was original. For example, the furo attribution should be left untouched imo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants