mirror of
https://github.com/RGBCube/GitHubWrapper
synced 2025-07-25 07:27:43 +00:00
Docs base plate?
This commit is contained in:
VarMonke
parent
359c483c66
commit
187f15f8bc
29 changed files with 3493 additions and 52 deletions
27
docs/_templates/genindex.html
vendored
Normal file
27
docs/_templates/genindex.html
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
{%- extends "basic/genindex.html" %}
|
||||
|
||||
{% block body %}
|
||||
{{ super() }}
|
||||
<!-- Inject some JavaScript to convert the index names into something useful. -->
|
||||
<script>
|
||||
let elements = document.querySelectorAll("table.indextable a");
|
||||
|
||||
// this is pretty finicky but it should work.
|
||||
for(let el of elements) {
|
||||
let key = el.getAttribute('href').split('#', 2)[1]
|
||||
if(!key.startsWith('discord.')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if(key.startsWith('discord.ext.')) {
|
||||
key = key.substr(12); // discord.ext.
|
||||
}
|
||||
|
||||
if(el.textContent.indexOf('()') !== -1) {
|
||||
key = key + '()'
|
||||
}
|
||||
el.textContent = key;
|
||||
}
|
||||
document.querySelectorAll("td").forEach(el => el.style.width = 'auto');
|
||||
</script>
|
||||
{% endblock %}
|
||||
196
docs/_templates/layout.html
vendored
Normal file
196
docs/_templates/layout.html
vendored
Normal file
|
|
@ -0,0 +1,196 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
|
||||
{%- block extrahead %} {% endblock %}
|
||||
<!-- end extra head -->
|
||||
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
|
||||
{%- block css %}
|
||||
{%- for css in css_files %}
|
||||
{%- if css|attr("filename") %}
|
||||
{{ css_tag(css) }}
|
||||
{%- else %}
|
||||
<link rel="stylesheet" href="{{ pathto(css, 1)|e }}" type="text/css" />
|
||||
{%- endif %}
|
||||
{%- endfor %}
|
||||
{%- endblock %}
|
||||
<link rel="stylesheet" href="{{ pathto('_static/style.css', 1)|e }}" type="text/css" />
|
||||
<link rel="stylesheet" href="{{ pathto('_static/codeblocks.css', 1) }}" type="text/css" />
|
||||
<link rel="stylesheet" href="{{ pathto('_static/icons.css', 1)|e }}" type="text/css" />
|
||||
{%- block scripts %}
|
||||
<script id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
|
||||
{%- for js in script_files %}
|
||||
{{ js_tag(js) }}
|
||||
{%- endfor %}
|
||||
{%- endblock %}
|
||||
{%- if pageurl %}
|
||||
<link rel="canonical" href="{{ pageurl|e }}" />
|
||||
{%- endif %}
|
||||
{%- if favicon %}
|
||||
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1)|e }}"/>
|
||||
{%- endif %}
|
||||
{%- block linktags %}
|
||||
{%- if hasdoc('about') %}
|
||||
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
|
||||
{%- endif %}
|
||||
{%- if hasdoc('genindex') %}
|
||||
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
|
||||
{%- endif %}
|
||||
{%- if hasdoc('search') %}
|
||||
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
|
||||
{%- endif %}
|
||||
{%- if hasdoc('copyright') %}
|
||||
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
|
||||
{%- endif %}
|
||||
{%- if prev %}
|
||||
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
|
||||
{%- endif %}
|
||||
{%- endblock %}
|
||||
</head>
|
||||
<body>
|
||||
{%- block header %}{% endblock %}
|
||||
<div class="main-grid">
|
||||
{#- The main navigation header #}
|
||||
<header class="grid-item">
|
||||
<nav>
|
||||
<a href="{{ pathto(master_doc)|e }}" class="main-heading">Github-API-Wrapper</a>
|
||||
<a href="https://github.com/VarMonke/Github-API-Wrapper" title="GitHub"><span class="material-icons custom-icons">github</span></a>
|
||||
<a href="{{ discord_invite }}" title="{{ _('Discord') }}"><span class="material-icons custom-icons">discord</span></a>
|
||||
<a href="{{ pathto('faq') }}" title="FAQ"><span class="material-icons">help_center</span></a>
|
||||
{#- If we have more links we can put them here #}
|
||||
<a onclick="mobileSearch.open();" title="{{ _('Search') }}" id="open-search" class="mobile-only"><span class="material-icons">search</span></a>
|
||||
<a onclick="mobileSearch.close();" title="{{ _('Close') }}" id="close-search" class="mobile-only" hidden><span class="material-icons">close</span></a>
|
||||
</nav>
|
||||
<nav class="mobile-only">
|
||||
<form role="search" class="search" action="{{ pathto('search') }}" method="get">
|
||||
<div class="search-wrapper">
|
||||
<input type="search" name="q" placeholder="{{ _('Search documentation') }}" />
|
||||
<button type="submit">
|
||||
<span class="material-icons">search</span>
|
||||
</button>
|
||||
</div>
|
||||
</form>
|
||||
</nav>
|
||||
</header>
|
||||
<div class="sub-header grid-item">
|
||||
<label for="documentation_select">{{ _('') }}</label>
|
||||
{#- The sub-header with search and extension related selection #}
|
||||
<form id="search-form" role="search" class="search" action="{{ pathto('search') }}" method="get">
|
||||
<div class="search-wrapper">
|
||||
<input type="search" name="q" placeholder="{{ _('Search documentation') }}" />
|
||||
<button type="submit" onmousedown="searchBarClick(event, document.getElementById('search-form'));">
|
||||
<span class="material-icons">search</span>
|
||||
</button>
|
||||
</div>
|
||||
</form>
|
||||
<a accesskey="S" class="settings" onclick="settingsModal.open();"><span class="material-icons">settings</span></a>
|
||||
</div>
|
||||
{#- The sidebar component #}
|
||||
<aside class="grid-item">
|
||||
{%- if display_toc %}
|
||||
<span id="hamburger-toggle">
|
||||
<span class="material-icons">menu</span>
|
||||
</span>
|
||||
{%- endif %}
|
||||
<span id="settings-toggle" class="settings" onclick="settingsModal.open();">
|
||||
<span class="material-icons">settings</span>
|
||||
</span>
|
||||
<div id="sidebar">
|
||||
<form id="sidebar-form" role="search" class="search" action="{{ pathto('search') }}" method="get">
|
||||
<div class="search-wrapper search-sidebar">
|
||||
<input type="search" name="q" placeholder="{{ _('Search documentation') }}" />
|
||||
<button type="submit" onmousedown="searchBarClick(event, document.getElementById('sidebar-form'));">
|
||||
<span class="material-icons">search</span>
|
||||
</button>
|
||||
</div>
|
||||
</form>
|
||||
{%- include "localtoc.html" %}
|
||||
</div>
|
||||
</aside>
|
||||
{#- The actual body of the contents #}
|
||||
<main class="grid-item" role="main">
|
||||
{% block body %} {% endblock %}
|
||||
</main>
|
||||
{%- block footer %}
|
||||
<footer class="grid-item">
|
||||
{%- if show_copyright %}
|
||||
{%- if hasdoc('copyright') %}
|
||||
{% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
|
||||
{%- else %}
|
||||
{% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
{%- if last_updated %}
|
||||
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
|
||||
{%- endif %}
|
||||
{%- if show_sphinx %}
|
||||
{% trans sphinx_version=sphinx_version|e %}Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
|
||||
{%- endif %}
|
||||
</footer>
|
||||
{%- endblock %}
|
||||
</div>
|
||||
{%- if READTHEDOCS %}
|
||||
<script>
|
||||
if (typeof READTHEDOCS_DATA !== "undefined") {
|
||||
if (!READTHEDOCS_DATA.features) {
|
||||
READTHEDOCS_DATA.features = {};
|
||||
}
|
||||
READTHEDOCS_DATA.features.docsearch_disabled = true;
|
||||
}
|
||||
</script>
|
||||
{%- endif %}
|
||||
|
||||
<div id="settings" class="modal" onclick="if (event.target == this){ settingsModal.close(); }" hidden>
|
||||
<div class="modal-content">
|
||||
<span class="close" onclick="settingsModal.close();" title="Close">
|
||||
<span class="material-icons">close</span>
|
||||
</span>
|
||||
<h1>{{ _('Settings') }}</h1>
|
||||
|
||||
<h2>{{ _('Font') }}</h2>
|
||||
<div class="setting">
|
||||
<h3>{{ _('Use a serif font:') }}
|
||||
<label class="toggle"
|
||||
title="{{ _('Use a serif font? Your system font will be used, falling back to serif.')}}">
|
||||
<input type="checkbox" name="useSerifFont" onclick="updateSetting(this);">
|
||||
<span class="toggle-slider"></span>
|
||||
</label>
|
||||
</h3>
|
||||
</div>
|
||||
|
||||
<h2>{{ _('Theme') }}</h2>
|
||||
<div class="setting">
|
||||
<h3>
|
||||
<label class="toggle" title="{{ _('Set your theme based on your system preferences') }}">
|
||||
<input type="radio" name="setTheme" onclick="updateSetting(this);" value="automatic" checked>
|
||||
</label>
|
||||
{{ _('Automatic') }}
|
||||
</h3>
|
||||
<h3>
|
||||
<label class="toggle" title="{{ _('Set your theme to light theme') }}">
|
||||
<input type="radio" name="setTheme" onclick="updateSetting(this);" value="light">
|
||||
</label>
|
||||
{{ _('Light') }}
|
||||
</h3>
|
||||
<h3>
|
||||
<label class="toggle" title="{{ _('Set your theme to dark theme') }}">
|
||||
<input type="radio" name="setTheme" onclick="updateSetting(this);" value="dark">
|
||||
</label>
|
||||
{{ _('Dark') }}
|
||||
</h3>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="to-top" onclick="scrollToTop()"{%- if READTHEDOCS %} class="is-rtd"{%- endif %} hidden>
|
||||
<span><span class="material-icons">arrow_upward</span> to top</span>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1
docs/_templates/relations.html
vendored
Normal file
1
docs/_templates/relations.html
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
<!-- purposefully empty -->
|
||||
Loading…
Add table
Add a link
Reference in a new issue