Skip to content

Commit

Permalink
Merge branch 'release/v0.1.8'
Browse files Browse the repository at this point in the history
  • Loading branch information
wpk committed Feb 14, 2023
2 parents c54ccb4 + 3cb3169 commit 53148f7
Show file tree
Hide file tree
Showing 8 changed files with 234 additions and 2 deletions.
64 changes: 64 additions & 0 deletions docs/_templates/boilerplate-footer.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<footer class="nist-footer">
<div class="nist-footer__inner">
<div class="nist-footer__menu" role="navigation">
<ul>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/privacy-policy">Privacy Statement</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/privacy-policy#privpolicy">Privacy Policy</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/privacy-policy#secnot">Security Notice</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/privacy-policy#accesstate">Accessibility Statement</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/privacy">NIST Privacy Program</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/no-fear-act-policy">No Fear Act Policy</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/disclaimer">Disclaimer</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/office-director/freedom-information-act">FOIA</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/environmental-policy-statement">Environmental Policy Statement</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.nist.gov/privacy-policy#cookie">Cookie Disclaimer</a>
</li>
<li class="nist-footer__menu-item ">
<a href="https://www.nist.gov/summary-report-scientific-integrity">Scientific Integrity Summary</a>
</li>
<li class="nist-footer__menu-item ">
<a href="https://www.nist.gov/nist-information-quality-standards">NIST Information Quality Standards</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://business.usa.gov/">Business USA</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.commerce.gov/">Commerce.gov</a>
</li>
<li class="nist-footer__menu-item">
<a href="https://www.healthcare.gov/">Healthcare.gov</a>
</li>
<li class="nist-footer__menu-item">
<a href="http://www.science.gov/">Science.gov</a>
</li>
<li class="nist-footer__menu-item">
<a href="http://www.usa.gov/">USA.gov</a>
</li>
</ul>
</div>
</div>
<div class="nist-footer__logo">
<a href="https://www.nist.gov/" title="National Institute of Standards and Technology" class="nist-footer__logo-link" rel="home">
<img src="https://pages.nist.gov/nist-header-footer/images/nist_logo_centered_rev.svg" alt="National Institute of Standards and Technology logo" />
</a>
</div>
</footer>
20 changes: 20 additions & 0 deletions docs/_templates/boilerplate-header.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<header class="nist-header" id="nist-header" role="banner">

<a href="https://www.nist.gov/" title="National Institute of Standards and Technology" class="nist-header__logo-link" rel="home">
<svg aria-hidden="true" class="nist-header__logo-icon" version="1.1" xmlns="http://www.w3.org/2000/svg" width="24" height="32" viewBox="0 0 24 32">
<path d="M20.911 5.375l-9.482 9.482 9.482 9.482c0.446 0.446 0.446 1.161 0 1.607l-2.964 2.964c-0.446 0.446-1.161 0.446-1.607 0l-13.25-13.25c-0.446-0.446-0.446-1.161 0-1.607l13.25-13.25c0.446-0.446 1.161-0.446 1.607 0l2.964 2.964c0.446 0.446 0.446 1.161 0 1.607z"></path>
</svg>
<svg class="nist-header__logo-image" version="1.1" xmlns="http://www.w3.org/2000/svg" viewBox="-237 385.7 109.7 29.3">
<title>National Institute of Standards and Technology</title>
<g>
<path class="st0" d="M-231,415h-6v-23.1c0,0,0-4.4,4.4-5.8c4-1.3,6.6,1.3,6.6,1.3l19.7,21.3c1,0.6,1.4,0,1.4-0.6v-22h6.1V409
c0,1.9-1.6,4.4-4,5.3c-2.4,0.9-4.9,0.9-7.9-1.7l-18.5-20c-0.5-0.5-1.8-0.6-1.8,0.4L-231,415L-231,415z"/>
<path class="st0" d="M-195,386.1h6.1v20.7c0,2.2,1.9,2.2,3.6,2.2h26.8c1.1,0,2.4-1.3,2.4-2.7c0-1.4-1.3-2.8-2.5-2.8H-176
c-3,0.1-9.2-2.7-9.2-8.5c0-7.1,5.9-8.8,8.6-9h49.4v6.1h-12.3V415h-6v-22.9h-30.2c-2.9-0.2-4.9,4.7-0.2,5.4h18.6
c2.8,0,7.4,2.4,7.5,8.4c0,6.1-3.6,9-7.5,9H-185c-4.5,0-6.2-1.1-7.8-2.5c-1.5-1.5-1.7-2.3-2.2-5.3L-195,386.1
C-194.9,386.1-195,386.1-195,386.1z"/>
</g>
</svg>
</a>

</header>
2 changes: 2 additions & 0 deletions docs/_templates/breadcrumbs.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{% include "boilerplate-header.html" %}
{% include "breadholder.html" %}
83 changes: 83 additions & 0 deletions docs/_templates/breadholder.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{# This is https://github.com/rtfd/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html completely unmodified #}
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}

{% if page_source_suffix %}
{% set suffix = page_source_suffix %}
{% else %}
{% set suffix = source_suffix %}
{% endif %}

{% if meta is defined and meta is not none %}
{% set check_meta = True %}
{% else %}
{% set check_meta = False %}
{% endif %}

{% if check_meta and 'github_url' in meta %}
{% set display_github = True %}
{% endif %}

{% if check_meta and 'bitbucket_url' in meta %}
{% set display_bitbucket = True %}
{% endif %}

{% if check_meta and 'gitlab_url' in meta %}
{% set display_gitlab = True %}
{% endif %}

<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">
{% block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> &raquo;</li>
{% for doc in parents %}
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
{% endfor %}
<li>{{ title }}</li>
{% endblock %}
{% block breadcrumbs_aside %}
<li class="wy-breadcrumbs-aside">
{% if hasdoc(pagename) %}
{% if display_github %}
{% if check_meta and 'github_url' in meta %}
<!-- User defined GitHub URL -->
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% else %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% endif %}
{% elif display_bitbucket %}
{% if check_meta and 'bitbucket_url' in meta %}
<!-- User defined Bitbucket URL -->
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% else %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% endif %}
{% elif display_gitlab %}
{% if check_meta and 'gitlab_url' in meta %}
<!-- User defined GitLab URL -->
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{% else %}
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{% endif %}
{% elif show_source and source_url_prefix %}
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
{% elif show_source and has_source and sourcename %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
{% endif %}
{% endif %}
</li>
{% endblock %}
</ul>

{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
{% if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
{% endif %}
{% if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
{% endif %}
</div>
{% endif %}
<hr/>
</div>
20 changes: 20 additions & 0 deletions docs/_templates/footer.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{% extends '!footer.html' %}

{% block extrafooter %}


<br></br>
{% include "boilerplate-footer.html" %}

<!-- Global site tag (gtag.js) - Google Analytics -->

<script async src="https://www.googletagmanager.com/gtag/js?id=UA-115121490-6"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-115121490-6');
</script>

{% endblock %}
43 changes: 43 additions & 0 deletions docs/_templates/layout.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{% extends '!layout.html' %}

{% block extrahead %}

<!-- frame blocking -->
<script type="text/javascript">
if (top !=self) {
top.location=self.location;
}
</script>



<!-- NIST header and footer -->
<link rel="stylesheet" href="https://pages.nist.gov/nist-header-footer/css/nist-combined.css">
<script src="https://code.jquery.com/jquery-1.12.4.min.js" type="text/javascript"></script>
<!-- <script src="https://pages.nist.gov/nist-header-footer/js/nist-header-footer.js" type="text/javascript" defer="defer"></script> -->


<script type="text/javascript" src="https://pages.nist.gov/leaveNotice/js/jquery.leaveNotice-nist.min.js"></script>
<script>
$(document).ready(function(){
// Mark external (non-nist.gov) A tags with class "external"
//If the adress start with https and ends with nist.gov
var re_nist = new RegExp('^https?:\/\/((^\/)*\.)*nist\\.gov(\/|$)');
//Regex to find address that start with https
var re_absolute_address = new RegExp('^((https?:)?\/\/)');
$("a").each(function(){
var url=$(this).attr('href');
if(re_nist.test(url) || !re_absolute_address.test(url)){
$(this).addClass('local');
}else{
//This a href appears to be external, so tag it
$(this).addClass('external');
}
});
// Add leaveNotice to external A elements
$('a.external').leaveNotice();
});
</script>
<link rel="stylesheet" type="text/css" href="https://pages.nist.gov/leaveNotice/css/jquery.leaveNotice.css" />

{% endblock %}
Empty file added docs/_templates/searchbox.html
View file
Empty file.
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
"nbsphinx",
# "sphinx_autosummary_accessors",
# "scanpydoc.rtd_github_links",
"sphinx.ext.viewcode",
# "sphinx.ext.linkcode",
# "sphinx.ext.viewcode",
"sphinx.ext.linkcode",
]


Expand Down

0 comments on commit 53148f7

Please sign in to comment.