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

Cannot place static html page in Sphinx template #63

Closed
johnsBeharry opened this issue Oct 3, 2023 · 3 comments · Fixed by #84 or #86
Closed

Cannot place static html page in Sphinx template #63

johnsBeharry opened this issue Oct 3, 2023 · 3 comments · Fixed by #84 or #86
Assignees
Labels
framework & docs meta-content

Comments

@johnsBeharry
Copy link
Contributor

Hey Team,

As you know, we've been trying to incorporate a custom index.html page in our [Jupyter Book/Sphinx] book that does not adhere to the standard theme and I've hit a roadblock.

Challenge

After exploring various options, it appears that Jupyter Book and Sphinx are not designed to easily allow a completely custom index.html that diverges from the set themes so the https://premai-book.netlify.app seems unusable at this point.

Proposed Solution

The fastest way to implement our custom index.html seems to be post-build where we'd:

  1. Run the standard Jupyter Book or Sphinx build command to generate the documentation.
  2. Execute a post-build script to replace the default index.html with our custom version.

Next Steps

  • I wouldn't want to break anything with the current site so would need someone to help with this script
@casperdcl
Copy link
Contributor

just open a PR with your current index.html (and any css/js assets it needs) & I'll fix it :)

@johnsBeharry
Copy link
Contributor Author

johnsBeharry commented Oct 3, 2023

Sent as a Zip file in slack to not pollute the git history

@Janaka-Steph
Copy link
Contributor

You don't pollute history with a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework & docs meta-content
Projects
No open projects
Status: Done
3 participants