glen/mkdocs-semiliterate
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 11 Wiki Activity

feat: Allow semiliterate to adjust the theme
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details

Browse source 
The mechanism here is to shadow a specified `custom.theme_dir` in the
  generated docs directory, and then ignore generated files therein (since they
  will be being used by the theme to render the pages, and are not actually
  part of the documentation).
This commit is contained in:
Glen Whitney 2022-08-09 08:17:37 -07:00
parent 86010351b7
commit b1203327ad
33 changed files with 3180 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

3
tests/fixtures/theme-modification/README.md vendored Normal file
View file

@ -0,0 +1,3 @@
# Test of syspath extraction
Hopefully Kilroy magically visited above.

4
tests/fixtures/theme-modification/doc_theme/.base.generator vendored Normal file
View file

@ -0,0 +1,4 @@
{! "\syspath mkdocs/themes/readthedocs/base.html"
extract:
replace: [ ['([<]body.*$)', '\1\n<p>Kilroy was here.</p>\n'] ]
!}

13
tests/fixtures/theme-modification/mkdocs.yml vendored Normal file
View file

@ -0,0 +1,13 @@
site_name: syspath inclusion
docs_dir: refsite # dummy
theme:
name: readthedocs
custom_dir: doc_theme/
plugins:
- semiliterate:
ignore_folders: [refsite, snippet]
merge_docs_dir: false
include_extensions: []
semiliterate:
- pattern: '[.](base).generator$' # Amend readthedocs theme
destination: '\1.html'

89
tests/fixtures/theme-modification/refsite/404.html.cropped vendored Normal file
View file

@ -0,0 +1,89 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>syspath inclusion</title>
<!--[if lt IE 9]>
<![endif]-->
</head>
<body class="wy-body-for-nav" role="document">
<p>Kilroy was here.</p>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="/." class="icon icon-home"> syspath inclusion
</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="/.">Test of syspath extraction</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/.">syspath inclusion</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="404-page-not-found">404</h1>
<p><strong>Page not found</strong></p>
</div>
</div><footer>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
</span>
</div>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</body>
</html>

BIN
tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Bold.woff vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Bold.woff2 vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Regular.woff vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/Roboto-Slab-Regular.woff2 vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.eot vendored Normal file
View file

Binary file not shown.

2671
tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.svg vendored Normal file
View file

File diff suppressed because it is too large Load diff
Side by side

After

Width:  |  Height:  |  Size: 434 KiB

BIN
tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.ttf vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.woff vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/fontawesome-webfont.woff2 vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-bold-italic.woff vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-bold-italic.woff2 vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-bold.woff vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-bold.woff2 vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-normal-italic.woff vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-normal-italic.woff2 vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-normal.woff vendored Normal file
View file

Binary file not shown.

BIN
tests/fixtures/theme-modification/refsite/css/fonts/lato-normal.woff2 vendored Normal file
View file

Binary file not shown.

13
tests/fixtures/theme-modification/refsite/css/theme.css vendored Normal file
View file

File diff suppressed because one or more lines are too long

191
tests/fixtures/theme-modification/refsite/css/theme_extra.css vendored Normal file
View file

@ -0,0 +1,191 @@
/*
* Wrap inline code samples otherwise they shoot of the side and
* can't be read at all.
*
* https://github.com/mkdocs/mkdocs/issues/313
* https://github.com/mkdocs/mkdocs/issues/233
* https://github.com/mkdocs/mkdocs/issues/834
*/
.rst-content code {
white-space: pre-wrap;
word-wrap: break-word;
padding: 2px 5px;
}
/**
* Make code blocks display as blocks and give them the appropriate
* font size and padding.
*
* https://github.com/mkdocs/mkdocs/issues/855
* https://github.com/mkdocs/mkdocs/issues/834
* https://github.com/mkdocs/mkdocs/issues/233
*/
.rst-content pre code {
white-space: pre;
word-wrap: normal;
display: block;
padding: 12px;
font-size: 12px;
}
/**
* Fix code colors
*
* https://github.com/mkdocs/mkdocs/issues/2027
*/
.rst-content code {
color: #E74C3C;
}
.rst-content pre code {
color: #000;
background: #f8f8f8;
}
/*
* Fix link colors when the link text is inline code.
*
* https://github.com/mkdocs/mkdocs/issues/718
*/
a code {
color: #2980B9;
}
a:hover code {
color: #3091d1;
}
a:visited code {
color: #9B59B6;
}
/*
* The CSS classes from highlight.js seem to clash with the
* ReadTheDocs theme causing some code to be incorrectly made
* bold and italic.
*
* https://github.com/mkdocs/mkdocs/issues/411
*/
pre .cs, pre .c {
font-weight: inherit;
font-style: inherit;
}
/*
* Fix some issues with the theme and non-highlighted code
* samples. Without and highlighting styles attached the
* formatting is broken.
*
* https://github.com/mkdocs/mkdocs/issues/319
*/
.rst-content .no-highlight {
display: block;
padding: 0.5em;
color: #333;
}
/*
* Additions specific to the search functionality provided by MkDocs
*/
.search-results {
margin-top: 23px;
}
.search-results article {
border-top: 1px solid #E1E4E5;
padding-top: 24px;
}
.search-results article:first-child {
border-top: none;
}
form .search-query {
width: 100%;
border-radius: 50px;
padding: 6px 12px; /* csslint allow: box-model */
border-color: #D1D4D5;
}
/*
* Improve inline code blocks within admonitions.
*
* https://github.com/mkdocs/mkdocs/issues/656
*/
.rst-content .admonition code {
color: #404040;
border: 1px solid #c7c9cb;
border: 1px solid rgba(0, 0, 0, 0.2);
background: #f8fbfd;
background: rgba(255, 255, 255, 0.7);
}
/*
* Account for wide tables which go off the side.
* Override borders to avoid weirdness on narrow tables.
*
* https://github.com/mkdocs/mkdocs/issues/834
* https://github.com/mkdocs/mkdocs/pull/1034
*/
.rst-content .section .docutils {
width: 100%;
overflow: auto;
display: block;
border: none;
}
td, th {
border: 1px solid #e1e4e5 !important; /* csslint allow: important */
border-collapse: collapse;
}
/*
* Without the following amendments, the navigation in the theme will be
* slightly cut off. This is due to the fact that the .wy-nav-side has a
* padding-bottom of 2em, which must not necessarily align with the font-size of
* 90 % on the .rst-current-version container, combined with the padding of 12px
* above and below. These amendments fix this in two steps: First, make sure the
* .rst-current-version container has a fixed height of 40px, achieved using
* line-height, and then applying a padding-bottom of 40px to this container. In
* a second step, the items within that container are re-aligned using flexbox.
*
* https://github.com/mkdocs/mkdocs/issues/2012
*/
.wy-nav-side {
padding-bottom: 40px;
}
/*
* The second step of above amendment: Here we make sure the items are aligned
* correctly within the .rst-current-version container. Using flexbox, we
* achieve it in such a way that it will look like the following:
*
* [No repo_name]
* Next >> // On the first page
* << Previous Next >> // On all subsequent pages
*
* [With repo_name]
* <repo_name> Next >> // On the first page
* <repo_name> << Previous Next >> // On all subsequent pages
*
* https://github.com/mkdocs/mkdocs/issues/2012
*/
.rst-versions .rst-current-version {
padding: 0 12px;
display: flex;
font-size: initial;
justify-content: space-between;
align-items: center;
line-height: 40px;
}
/*
* Please note that this amendment also involves removing certain inline-styles
* from the file ./mkdocs/themes/readthedocs/versions.html.
*
* https://github.com/mkdocs/mkdocs/issues/2012
*/
.rst-current-version span {
flex: 1;
text-align: center;
}

BIN
tests/fixtures/theme-modification/refsite/img/favicon.ico vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.1 KiB

97
tests/fixtures/theme-modification/refsite/index.html.cropped vendored Normal file
View file

@ -0,0 +1,97 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="None" />
<title>syspath inclusion</title>
// Current page data
var mkdocs_page_name = "Test of syspath extraction";
var mkdocs_page_input_path = "README.md";
var mkdocs_page_url = null;
<!--[if lt IE 9]>
<![endif]-->
</head>
<body class="wy-body-for-nav" role="document">
<p>Kilroy was here.</p>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> syspath inclusion
</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href=".">Test of syspath extraction</a>
<ul class="current">
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">syspath inclusion</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Test of syspath extraction</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="test-of-syspath-extraction">Test of syspath extraction</h1>
<p>Hopefully Kilroy magically visited above.</p>
</div>
</div><footer>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
</span>
</div>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</body>
</html>
<!--
-->

4
tests/fixtures/theme-modification/refsite/js/html5shiv.min.js vendored Normal file
View file

@ -0,0 +1,4 @@
/**
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
*/
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);

2
tests/fixtures/theme-modification/refsite/js/jquery-3.6.0.min.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

2
tests/fixtures/theme-modification/refsite/js/theme.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

8
tests/fixtures/theme-modification/refsite/js/theme_extra.js vendored Normal file
View file

@ -0,0 +1,8 @@
/*
* Assign 'docutils' class to tables so styling and
* JavaScript behavior is applied.
*
* https://github.com/mkdocs/mkdocs/issues/2028
*/
$('div.rst-content table').addClass('docutils');

8
tests/fixtures/theme-modification/refsite/sitemap.xml vendored Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>None</loc>
<lastmod>2022-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
tests/fixtures/theme-modification/refsite/sitemap.xml.gz vendored Normal file
View file

Binary file not shown.