From e8337b75b023af7338d61d8afd102f068bd59719 Mon Sep 17 00:00:00 2001 From: nabobalis Date: Sat, 10 Mar 2018 17:27:21 +0100 Subject: [PATCH 01/17] Start of the fixes --- .circleci/config.yml | 33 +++++++++++++++++++++-------- .travis.yml | 30 -------------------------- sunpy_sphinx_theme/conf.py | 5 +++-- sunpy_sphinx_theme/sunpy/theme.conf | 1 + 4 files changed, 28 insertions(+), 41 deletions(-) delete mode 100644 .travis.yml diff --git a/.circleci/config.yml b/.circleci/config.yml index 8de72e43f..3dbbf8447 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -10,11 +10,23 @@ pip-run: &pip-install python3 -m venv venv echo "source /home/circleci/project/venv/bin/activate" >> $BASH_ENV +npm-run: &npm-install + name: Install NPM dependencies + command: | + sudo apt update + sudo npm install -g stylelint + sudo npm install -g stylelint-config-recommended + version: 2 jobs: - html-docs: - environment: - - MAIN_CMD: "pip install -e ." + linter: + docker: + - image: circleci/node:4.8.2 + steps: + - run: *npm-install + - run: stylelint sunpy_sphinx_theme/sunpy/static/style.css + + website: docker: - image: circleci/python:3.6 steps: @@ -22,27 +34,30 @@ jobs: - run: *apt-install - run: *pip-install - run: pip install -U setuptools - - run: $MAIN_CMD $SETUP_CMD + - run: pip install -e . - run: git clone https://github.com/sunpy/sunpy.github.io.git - - run: pip install -r $HOME/project/sunpy.github.io/requirements.txt + - run: pip install -r sunpy.github.io/requirements.txt - run: pip install -U sphinx - run: make -C $HOME/project/sunpy.github.io html - run: rm $HOME/project/sunpy.github.io/_build/html/CNAME - store_artifacts: - path: $HOME/project/sunpy.github.io/_build/html + path: sunpy.github.io/_build/html - run: name: "Built documentation is available at:" command: DOCS_URL="${CIRCLE_BUILD_URL}/artifacts/${CIRCLE_NODE_INDEX}/${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}/project/sunpy.github.io/_build/html/index.html"; echo $DOCS_URL - workflows: version: 2 - test-documentation: + test-linter: + jobs: + - linter + + test-website-build: jobs: - - html-docs + - website notify: webhooks: diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 30414e3a3..000000000 --- a/.travis.yml +++ /dev/null @@ -1,30 +0,0 @@ -language: python - -python: - - 3.6 - -before_install: - - npm install -g stylelint - - npm install stylelint-config-recommended - - stylelint ./sunpy_sphinx_theme/sunpy/static/style.css - -install: - - pip install -e . - - git clone https://github.com/sunpy/sunpy.github.io.git - - cd sunpy.github.io - - pip install -r requirements.txt - - pip install -U sphinx - -script: - - make html - - rm ./_build/html/CNAME - -deploy: - edge: - branch: v1.8.47 - provider: pages - skip_cleanup: true - github_token: $mytoken - local_dir: sunpy.github.io/_build/html/ - on: - branch: master diff --git a/sunpy_sphinx_theme/conf.py b/sunpy_sphinx_theme/conf.py index 032a00246..fdc91cc41 100644 --- a/sunpy_sphinx_theme/conf.py +++ b/sunpy_sphinx_theme/conf.py @@ -17,6 +17,7 @@ def page_url(page): 'navbar_links': [ ("Support Us", page_url("contribute.html"), 1), ("Get Help", page_url("help.html"), 1), - ("SunPy Project", page_url("team.html"), 1), - ] + ("SunPy Project", page_url("team.html"), 1) + ], + 'html_sidebars': {'**': ['docsidebar.html']} } diff --git a/sunpy_sphinx_theme/sunpy/theme.conf b/sunpy_sphinx_theme/sunpy/theme.conf index a6ea20fe7..7e7af01e9 100644 --- a/sunpy_sphinx_theme/sunpy/theme.conf +++ b/sunpy_sphinx_theme/sunpy/theme.conf @@ -6,6 +6,7 @@ navbar_pagenav = False source_link_position = False bootswatch_theme = flatly bootstrap_version = 3 +html_sidebars = logo_url = http://sunpy.org/ opengraph_image = img/sunpy_icon.svg From 0f960f76705b2a12bb439c0eeb56e1d5d421b5a4 Mon Sep 17 00:00:00 2001 From: nabobalis Date: Sat, 10 Mar 2018 19:28:34 +0100 Subject: [PATCH 02/17] AF dropdown update --- sunpy_sphinx_theme/sunpy/navbar.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sunpy_sphinx_theme/sunpy/navbar.html b/sunpy_sphinx_theme/sunpy/navbar.html index cd85fb74a..296220846 100644 --- a/sunpy_sphinx_theme/sunpy/navbar.html +++ b/sunpy_sphinx_theme/sunpy/navbar.html @@ -38,10 +38,10 @@ IRISPy
  • - SolarBExtrapolation + ndcube
  • - sunkit-sst + drms
  • radiospectra From a483d511a84b85ba9367402483fbd12b3da94ff2 Mon Sep 17 00:00:00 2001 From: nabobalis Date: Sat, 10 Mar 2018 19:50:25 +0100 Subject: [PATCH 03/17] maybe gallery download button fix --- .circleci/config.yml | 23 ++++++- LICENSE.md | 2 +- setup.py | 6 +- sunpy_sphinx_theme/__init__.py | 7 +- sunpy_sphinx_theme/conf.py | 18 +++-- sunpy_sphinx_theme/sunpy/layout.html | 11 ++- sunpy_sphinx_theme/sunpy/navbar.html | 4 +- .../static/{style.css => sunpy_style.css} | 69 +++++++++++-------- sunpy_sphinx_theme/sunpy/static/version.js | 2 +- sunpy_sphinx_theme/sunpy/theme.conf | 7 +- tool.py | 7 ++ 11 files changed, 104 insertions(+), 52 deletions(-) rename sunpy_sphinx_theme/sunpy/static/{style.css => sunpy_style.css} (96%) create mode 100644 tool.py diff --git a/.circleci/config.yml b/.circleci/config.yml index 3dbbf8447..a213958a1 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -48,6 +48,26 @@ jobs: name: "Built documentation is available at:" command: DOCS_URL="${CIRCLE_BUILD_URL}/artifacts/${CIRCLE_NODE_INDEX}/${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}/project/sunpy.github.io/_build/html/index.html"; echo $DOCS_URL + docs: + docker: + - image: circleci/python:3.6 + steps: + - checkout + - run: *apt-install + - run: *pip-install + - run: pip install -U setuptools + - run: git clone --depth 1 https://github.com/sunpy/sunpy.git + - run: cd sunpy && pip install -e . + - run: pip install -r sunpy/requirements/docs.txt + - run: cd sunpy && python setup.py build_docs -w + + - store_artifacts: + path: sunpy/docs/_build/html + + - run: + name: "Built documentation is available at:" + command: DOCS_URL="${CIRCLE_BUILD_URL}/artifacts/${CIRCLE_NODE_INDEX}/${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}/project/sunpy/docs/_build/html/index.html"; echo $DOCS_URL + workflows: version: 2 @@ -55,9 +75,10 @@ workflows: jobs: - linter - test-website-build: + test-html-build: jobs: - website + - docs notify: webhooks: diff --git a/LICENSE.md b/LICENSE.md index 25044c3dc..bac15dde7 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ BSD 2-Clause License -Copyright (c) 2017, The SunPy Developers +Copyright (c) 2018, The SunPy Developers All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/setup.py b/setup.py index 67b4335ee..900d54806 100644 --- a/setup.py +++ b/setup.py @@ -1,11 +1,11 @@ -from setuptools import setup, find_packages +from setuptools import setup setup( name="sunpy-sphinx-theme", - version="1.0.7", + version="1.1.0", use_2to3=False, description="The sphinx theme for the SunPy website and documentation.", - long_description="", + long_description="The sphinx theme for the SunPy website and documentation.", author="The SunPy Developers", install_requires=[ "setuptools", diff --git a/sunpy_sphinx_theme/__init__.py b/sunpy_sphinx_theme/__init__.py index fe4a5008e..36c6c1e98 100644 --- a/sunpy_sphinx_theme/__init__.py +++ b/sunpy_sphinx_theme/__init__.py @@ -1,10 +1,11 @@ -""" SunPy Sphinx Theme """ +"""SunPy Sphinx Theme""" import os -__version__ = "1.0.7" - import sphinx_bootstrap_theme +__version__ = "1.1.0" + + def get_html_theme_path(): """Return list of HTML theme paths.""" cur_dir = os.path.abspath(os.path.dirname(__file__)) diff --git a/sunpy_sphinx_theme/conf.py b/sunpy_sphinx_theme/conf.py index fdc91cc41..419f4c70a 100644 --- a/sunpy_sphinx_theme/conf.py +++ b/sunpy_sphinx_theme/conf.py @@ -1,23 +1,29 @@ import os try: - from urllib.parse import urljoin + from urllib.parse import urljoin, urlparse except ImportError: - from urlparse import urljoin -from . import get_html_theme_path + from urlparse import urljoin, urlparse + +from sunpy_sphinx_theme import get_html_theme_path html_theme_path = get_html_theme_path() html_theme = "sunpy" -html_favicon = os.path.join(html_theme_path[0], html_theme, "static", "img", "favicon-32.ico") +html_static_path = [os.path.join(html_theme_path[0], html_theme, "static")] +html_favicon = os.path.join(html_static_path[0], "img", "favicon-32.ico") + def page_url(page): sunpy_website_url_base = "http://sunpy.org/" return urljoin(sunpy_website_url_base, page) + +html_sidebars = {'**': ['docsidebar.html']} html_theme_options = { 'navbar_links': [ + ("About", page_url("about.html"), 1), + ("Blog", page_url("blog.html"), 1), ("Support Us", page_url("contribute.html"), 1), ("Get Help", page_url("help.html"), 1), ("SunPy Project", page_url("team.html"), 1) - ], - 'html_sidebars': {'**': ['docsidebar.html']} + ] } diff --git a/sunpy_sphinx_theme/sunpy/layout.html b/sunpy_sphinx_theme/sunpy/layout.html index 5112a21e3..6f29237b8 100644 --- a/sunpy_sphinx_theme/sunpy/layout.html +++ b/sunpy_sphinx_theme/sunpy/layout.html @@ -1,12 +1,11 @@ -{# Import the theme's layout. #} +{# Import the theme's layout #} {% extends "bootstrap/layout.html" %} -{# Custom CSS overrides #} -{% set css_files = css_files + ['_static/style.css'] %} +{# Extra JS files #} {% set script_files = script_files + ['_static/copybutton.js'] + ['_static/version.js']%} -{# Add some extra stuff before and use existing with 'super()' call. #} - +{# Custom CSS overrides #} +{% set css_files = css_files + ['_static/sunpy_style.css'] %} +{# Add some extra stuff before and use existing with 'super()' call #} {%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and sidebars %} - {%- set bs_content_width2 = render_sidebar and "8" or "12"%} {% macro seo_title() -%} diff --git a/sunpy_sphinx_theme/sunpy/navbar.html b/sunpy_sphinx_theme/sunpy/navbar.html index 296220846..0550fba25 100644 --- a/sunpy_sphinx_theme/sunpy/navbar.html +++ b/sunpy_sphinx_theme/sunpy/navbar.html @@ -17,10 +17,10 @@ About
    • - About + About
    • - Acknowledge + Acknowledge
    • Code of Conduct diff --git a/sunpy_sphinx_theme/sunpy/static/style.css b/sunpy_sphinx_theme/sunpy/static/sunpy_style.css similarity index 96% rename from sunpy_sphinx_theme/sunpy/static/style.css rename to sunpy_sphinx_theme/sunpy/static/sunpy_style.css index 084d36520..c29d69549 100644 --- a/sunpy_sphinx_theme/sunpy/static/style.css +++ b/sunpy_sphinx_theme/sunpy/static/sunpy_style.css @@ -1,5 +1,6 @@ @import url('https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,600,700,900'); +/* Main SunPy Styling */ body { background-color: white; color: #333; @@ -426,16 +427,6 @@ dt:target, /* Button */ -div.sphx-glr-download a { - background-color: white; - background-image: none !important; - border: 1px solid #fe7900; -} - -div.sphx-glr-download a:hover { - background-color: #fe7900; -} - blockquote { font-size: 17px; } @@ -450,27 +441,10 @@ blockquote { display: table-cell; } -div.sphx-glr-footer.docutils.container { - width: 70%; - display: inline-flex; -} - div.figure p.caption span.caption-text { text-align: center; } -.sphx-glr-thumbcontainer[tooltip]::hover::after { - bottom: -45%; - left: 0%; -} - -.sphx-glr-thumbcontainer[tooltip]::hover::before { - display: none; -} - -.sphx-glr-thumbcontainer a.internal { - padding: 130px 10px 0; -} .rst-versions.rst-badge { bottom: 50px; @@ -719,3 +693,44 @@ div.figure p.caption span.caption-text { margin-top: 10px; margin-bottom: 10px; } + +@media only screen and (min-width: 190ex) { + div.sphx-glr-footer-example { +max-width: 100%; + } +} + +div.sphx-glr-footer-example { + position: initial; + background: rgba(200, 200, 200, 0); + border: none; + max-width: 100ex; +} + +div.sphx-glr-footer.docutils.container { + width: 70%; + display: inline-flex; +} + +div.sphx-glr-download a { + background-color: white; + background-image: none !important; + border: 1px solid #fe7900; +} + +div.sphx-glr-download a:hover { + background-color: #fe7900; +} + +.sphx-glr-thumbcontainer[tooltip]:hover::after { + bottom: -45%; + left: 0; +} + +.sphx-glr-thumbcontainer[tooltip]:hover::before { + display: none; +} + +.sphx-glr-thumbcontainer a.internal { + padding: 130px 10px 0; +} \ No newline at end of file diff --git a/sunpy_sphinx_theme/sunpy/static/version.js b/sunpy_sphinx_theme/sunpy/static/version.js index 8041c3ec9..b0630ab55 100644 --- a/sunpy_sphinx_theme/sunpy/static/version.js +++ b/sunpy_sphinx_theme/sunpy/static/version.js @@ -1,4 +1,4 @@ $.getJSON('https://pypi.python.org/pypi/sunpy/json', function(data) { ver= 'Current Version: ' + data.info.version; $('.version').html(ver); -}); \ No newline at end of file +}); diff --git a/sunpy_sphinx_theme/sunpy/theme.conf b/sunpy_sphinx_theme/sunpy/theme.conf index 7e7af01e9..d18f333d4 100644 --- a/sunpy_sphinx_theme/sunpy/theme.conf +++ b/sunpy_sphinx_theme/sunpy/theme.conf @@ -2,19 +2,22 @@ inherit=bootstrap [options] +# Settings from the bootstrap theme navbar_pagenav = False source_link_position = False bootswatch_theme = flatly bootstrap_version = 3 -html_sidebars = +# Defaults for SunPy projects logo_url = http://sunpy.org/ opengraph_image = img/sunpy_icon.svg twitter_id = sunpyproject github_user = sunpy github_repo = sunpy social_buttons = True -copyright_html = +# Empty settings for the theme +copyright_html = seo_description = base_url = +html_sidebars = diff --git a/tool.py b/tool.py new file mode 100644 index 000000000..d1a96220f --- /dev/null +++ b/tool.py @@ -0,0 +1,7 @@ +from jinja2 import Environment, PackageLoader, meta +import jinja2schema +env = Environment(loader=PackageLoader('sunpy_sphinx_theme', 'sunpy')) +template_source = env.loader.get_source(env,'docsidebar.html')[0] +parsed_content = env.parse(template_source) +meta.find_undeclared_variables(parsed_content) +abc = jinja2schema.infer(template_source) From 1b48cab67f58b2cddd35598af2e666a28d2cb1e2 Mon Sep 17 00:00:00 2001 From: nabobalis Date: Fri, 13 Apr 2018 16:32:37 +0200 Subject: [PATCH 04/17] navbar reorder --- .circleci/config.yml | 2 +- .stylelintrc | 7 +-- sunpy_sphinx_theme/conf.py | 15 ++++-- sunpy_sphinx_theme/sunpy/navbar.html | 73 +++++++++++++--------------- 4 files changed, 49 insertions(+), 48 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index a213958a1..95ece74c4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -24,7 +24,7 @@ jobs: - image: circleci/node:4.8.2 steps: - run: *npm-install - - run: stylelint sunpy_sphinx_theme/sunpy/static/style.css + - run: stylelint sunpy_sphinx_theme/sunpy/static/sunpy_style.css website: docker: diff --git a/.stylelintrc b/.stylelintrc index 3d8833da7..25470207b 100644 --- a/.stylelintrc +++ b/.stylelintrc @@ -1,6 +1,7 @@ { "extends": "stylelint-config-recommended", - "rules": {"no-descending-specificity": null, - "selector-pseudo-element-no-unknown": null - } + "rules": { + "no-descending-specificity": null, + "selector-pseudo-element-no-unknown": null + } } diff --git a/sunpy_sphinx_theme/conf.py b/sunpy_sphinx_theme/conf.py index 419f4c70a..5ad742e91 100644 --- a/sunpy_sphinx_theme/conf.py +++ b/sunpy_sphinx_theme/conf.py @@ -1,8 +1,9 @@ import os try: - from urllib.parse import urljoin, urlparse + from urllib.parse import urljoin except ImportError: - from urlparse import urljoin, urlparse + from urlparse import urljoin +import socket from sunpy_sphinx_theme import get_html_theme_path @@ -11,16 +12,20 @@ html_static_path = [os.path.join(html_theme_path[0], html_theme, "static")] html_favicon = os.path.join(html_static_path[0], "img", "favicon-32.ico") +deploy = False +if deploy: + sunpy_website_url_base = "http://sunpy.org/" +else: + sunpy_website_url_base = socket.gethostname() + def page_url(page): - sunpy_website_url_base = "http://sunpy.org/" return urljoin(sunpy_website_url_base, page) html_sidebars = {'**': ['docsidebar.html']} html_theme_options = { - 'navbar_links': [ - ("About", page_url("about.html"), 1), + 'navbar_links': [ # About and documentation is hard coded due to drop down ("Blog", page_url("blog.html"), 1), ("Support Us", page_url("contribute.html"), 1), ("Get Help", page_url("help.html"), 1), diff --git a/sunpy_sphinx_theme/sunpy/navbar.html b/sunpy_sphinx_theme/sunpy/navbar.html index 0550fba25..22997b8bf 100644 --- a/sunpy_sphinx_theme/sunpy/navbar.html +++ b/sunpy_sphinx_theme/sunpy/navbar.html @@ -1,56 +1,51 @@ -
      +