Skip to content
This repository was archived by the owner on Apr 24, 2020. It is now read-only.

ENH: Basic generic theme - css, js, tpl - #697

Open
mmcky wants to merge 22 commits into
masterfrom
generic-theme
Open

ENH: Basic generic theme - css, js, tpl#697
mmcky wants to merge 22 commits into
masterfrom
generic-theme

Conversation

@mmcky

@mmcky mmcky commented Oct 8, 2019

Copy link
Copy Markdown
Collaborator

This PR adds a basic theme for editing tasks.

@mmcky mmcky left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@DrDrij it would be nice to have support for index.html and index_toc.html (for multiple toc elements).

Comment thread conf.py Outdated
site_title = 'Jupinx Base Theme'
site_description = ''
site_keywords = ''
site_author = ''

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

what is the difference between this and author?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

these should be removed and added to jupyter_ section

Comment thread conf.py Outdated
copyright = '2019, Thomas J. Sargent and John Stachurski'
author = 'Thomas J. Sargent and John Stachurski'
site_title = 'Jupinx Base Theme'
site_description = ''

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

should this be = project

@mmcky mmcky added the in-work label Oct 9, 2019
@mmcky

mmcky commented Oct 10, 2019

Copy link
Copy Markdown
Collaborator Author

Thanks @DrDrij.
@jstac here are a few images of the generic-theme that we will deploy with jupinx

Index Page

image

TOC

image

Lecture Page

image

@DrDrij all the elements presented are in the RST files now right (i.e. QuantEcon Logo's) are all based on RST inputs?

@mmcky

mmcky commented Oct 10, 2019

Copy link
Copy Markdown
Collaborator Author
  • @mmcky remove the publish theme and add in generic-theme for editing and local compilation.

@mmcky

mmcky commented Oct 10, 2019

Copy link
Copy Markdown
Collaborator Author
  • @DrDrij should support tne status badges for coverage tests? YES and this is already included. Thankd @DrDrij

@mmcky

mmcky commented Oct 11, 2019

Copy link
Copy Markdown
Collaborator Author

hey @DrDrij do we still need python-html.tpl?

@DrDrij

DrDrij commented Oct 11, 2019

Copy link
Copy Markdown
Member

Template removed @mmcky

@mmcky

mmcky commented Oct 11, 2019

Copy link
Copy Markdown
Collaborator Author

thanks @DrDrij is this asset missing in generic-theme. Is this in img or does it need to be in _static?

<img src="/_static/sloan-logo.png" alt="Sponsored by the Alfred P. Sloan Foundation">

Screen Shot 2019-10-11 at 8 39 47 pm

Comment thread source/rst/index.rst Outdated
<ul class="sponsor">
<li><a href="http://www.sloan.org/" title="Alfred P. Sloan Foundation"><img src="/_static/sloan_logo.png" alt="Sponsored by the Alfred P. Sloan Foundation"></a></li>
<li><a href="https://quantecon.org/"><img src="/_static/img/qe-logo.png" width="150"></a></li>
<li><a href="http://www.sloan.org/" title="Alfred P. Sloan Foundation"><img src="/_static/sloan-logo.png" alt="Sponsored by the Alfred P. Sloan Foundation"></a></li>

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@DrDrij I think this should be sloan_logo.png with an _ rather than a -

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

fixed it

@mmcky mmcky left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

hey @DrDrij had a deeper think about the static assets and where they should be kept.

Comment thread source/rst/index.rst
</div>
<div class="web-version">
<a href="/index_toc.html">
<span class="thumb"><img src="/_static/img/py-logo.png"></span>

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@DrDrij one thought I have had with moving these to the _static folder is that they are not assets that are tracked by sphinx. For example they are not in .. figure or .. image directives. This means they will never be parsed by sphinx and perhaps should remain in the theme folder and copied to static as part of the theme support (as is currently done?). What do you think?

This PR: QuantEcon/sphinxcontrib-jupyter#268 would actually break this setup currently as the static assets contained in the html snippets would never be parsed by sphinx.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@DrDrij what do you think about this?

@mmcky

mmcky commented Oct 15, 2019

Copy link
Copy Markdown
Collaborator Author
  • this PR requires an update to aws management tools to compile with qe theme for publishing.

@mmcky mmcky removed the in-work label Oct 16, 2019
@jstac

jstac commented Jan 28, 2020

Copy link
Copy Markdown
Contributor

Hi @mmcky, is this still active? Anything I need to do?

@mmcky

mmcky commented Mar 10, 2020

Copy link
Copy Markdown
Collaborator Author

this will be implemented in the split of projects #950

@shlff
shlff requested review from AakashGfude and DrDrij March 10, 2020 19:39
@shlff shlff added the in-work label Mar 10, 2020
@mmcky mmcky added the on-hold label Mar 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants