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

Allow template for index.html to be in source branch #10

Open
goerz opened this issue Aug 4, 2020 · 0 comments
Open

Allow template for index.html to be in source branch #10

goerz opened this issue Aug 4, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@goerz
Copy link
Owner

goerz commented Aug 4, 2020

In line with the design goal of keeping all configuration for doctr-versions-menu on the source branch (#6, #7, #9), it might be good to have some way for the index.html_t template file for customizing index.html live on master.

Fundamentally, this is tricky, because it is not trivial to move files between branches during the deploy. However, the resolution to #6 showed that environment variables are a good way to transfer data outside of the file system. Maybe, in addition to looking for a file index.html_t on gh-pages, doctr-versions-menu could also check whether an environment variable DOCTR_VERSIONS_MENU_INDEX_HTML_TEMPLATE is defined that contains the full template. Then, index.html_t could be stored on the master branch (e.g. in docs/_templates alongside the other Sphinx templates), and .travis.yml could read the contents of that file into an environment variable.

@goerz goerz added the enhancement New feature or request label Aug 4, 2020
@goerz goerz added this to the 0.4.0 milestone Aug 4, 2020
@goerz goerz removed this from the 0.4.0 milestone Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant