sascha_hemi/pycom-documentation
1
0
Fork 0
mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-21 05:06:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

recopy from pydocs review input

Browse Source
This commit is contained in:
Emmanuel Florent
2019-06-28 11:21:02 +02:00
parent 25b2c660b0
commit b86f87e629
9 changed files with 76 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
layouts/_default/baseof.html
View File

@@ -14,27 +14,20 @@
</head> </head>
<body> <body>
<v-app id="app" class="grey lighten-5" v-cloak stylse="display: none;"> <v-app id="app" class="grey lighten-5" v-cloak stylse="display: none;">
{{ partial "menu.html" . }} {{ partial "menu.html" . }}
{{- partial "toolbar.html" . -}} {{- partial "toolbar.html" . -}}
<v-content > <v-content >
<v-container class="fluid pa-4"> <v-container class="fluid pa-4">
<v-container class="ma-1 pa-1"> <v-container class="ma-1 pa-1">
{{- partial "menu-contextual.html" . -}}
{{- block "main" . }}{{- end }}
</v-container>
</v-container>
</v-content>
<!--
{{- partial "footer.html" . -}}
-->
{{- partial "menu-contextual.html" . -}}
{{- block "main" . }}{{- end }}
</v-container>
</v-container>
</v-content>
{{- partial "footer.html" . -}}
</v-app> </v-app>
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script> <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
@@ -63,8 +56,8 @@
drawer2: true, drawer2: true,
toc: 0, toc: 0,
branches: [ branches: [
{ value: 'https://development.pycom.io', text: 'development version'}, { value: 'https://docs.pycom.io', text: 'version stable', },
{ value: 'https://docs.pycom.io', text: 'version stable', } { value: 'https://development.pycom.io', text: 'version development'},
], ],
branch: "" branch: ""
}, },
@@ -102,7 +95,7 @@
fetchResults (kw, start) { fetchResults (kw, start) {
if (!start) { start = 1 } if (!start) { start = 1 }
let key = "AIzaSyD4-MGytNzTCZpTH6UYk1mfOxZkt74T5MI"; let key = "AIzaSyD4-MGytNzTCZpTH6UYk1mfOxZkt74T5MI";
let cx = "004592132197158309932:jleutbge8gs"; let cx = "004592132197158309932:anluf60c9w8";
let url = "https://www.googleapis.com/customsearch/v1"; let url = "https://www.googleapis.com/customsearch/v1";
url = url + "?cx=" + cx + "&key=" + key + "&q=" + encodeURI(kw) + "&start=" + start url = url + "?cx=" + cx + "&key=" + key + "&q=" + encodeURI(kw) + "&start=" + start

8
layouts/_default/list.html
View File

@@ -2,21 +2,21 @@
<v-card> <v-card>
<v-card-text> <v-card-text>
{{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }} {{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }}
{{ if .Title }}<h1>{{- .Title -}}</h1>{{ end }} <h1>{{- .Title -}}</h1>
{{- .Content -}} {{- .Content -}}
<ul> <ul>
{{ if lt .WordCount 10 }} {{ if lt .WordCount 10 }}
{{ range .Paginator.Pages }} {{ range .Paginator.Pages }}
<li><a href="{{ .URL }}"> <li><a href="{{ .URL }}">
{{ if .Title }}{{ .Title }}{{ else }}{{ .URL }}{{ end }} {{ if .Title }}{{ .Title }}{{ else }}{{ .URL }}{{ end }}<a/></li>
<a/></li>
{{ end }} {{ end }}
{{ end }} {{ end }}
</ul> </ul>
</v-card-text> </v-card-text>
</v-card> </v-card>
<p>&nbsp;</p> <p>&nbsp;</p>
{{ partial "prev_next.html" (dict "menu" .Site.Menus.main "page" . ) }} {{ partial "prev_next.html" (dict "menu" .Site.Menus.main "page" . ) }}
<v-spacer/>
{{ end }} {{ end }}

2
layouts/shortcodes/refname.html
View File

@@ -1,4 +1,4 @@
{{ $p := .Get 0 }} {{ $p := .Get 0 }}
{{ with .Page.GetPage $p }} {{ with .Page.GetPage $p }}
<a href="{{ $p }}">{{ .Title }}</a> <a href="{{ .URL }}">{{ .Title }}</a>
{{ end }} {{ end }}

2
themes/doc-theme/layouts/partials/breadcrumb.html
View File

@@ -1,3 +1,3 @@
<p> <p>
{{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }} {{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }}
</p> </p>

9
themes/doc-theme/layouts/partials/breadcrumb_recursive.html
View File

@@ -1,8 +1,12 @@
{{ $page := .page }} {{ $page := .page }}
{{ $prev := . }} {{ $level := 1 }}
{{ $prev := . }}
{{ range .menu }} {{ range .menu }}
{{ $iz := eq $page.URL .URL}} {{ $iz := eq $page.URL .URL}}
{{ $haz := in $page.URL .URL}} {{ $haz := in $page.URL .URL}}
@@ -14,7 +18,7 @@
<a href="{{ .URL | relURL }}" class="bread {{ if or $iz $haz }}hot{{end}}"> {{ .Pre }} {{ .Name }}</a> <a href="{{ .URL | relURL }}" class="bread {{ if or $iz $haz }}hot{{end}}"> {{ .Pre }} {{ .Name }}</a>
{{ if not $iz }}>{{ end }} {{ if not $iz }}>{{ end }}
{{ end }} {{ end }}
{{ partial "breadcrumb_recursive.html" (dict "menu" .Children "page" $page) }} {{ partial "breadcrumb_recursive.html" (dict "menu" .Children "page" $page "level" $level) }}
{{ if or $iz $haz }} {{ if or $iz $haz }}
@@ -36,3 +40,4 @@
{{ end }} {{ end }}
{{ end }} {{ end }}
</ul>

28
themes/doc-theme/layouts/partials/menu.html
View File

@@ -5,14 +5,12 @@
class="lighten-4 pt-0" class="lighten-4 pt-0"
style="overflow-y: hidden; overflow-x: hidden;" style="overflow-y: hidden; overflow-x: hidden;"
> >
<v-container style="height: 68px; background-color: rgb(23, 23, 48);" class="dark mb-0 pb-1 pt-3 elevation-5"> <v-container style="height: 68px; background-color: rgb(23, 23, 48);" class="dark mb-0 pb-1 pt-3 elevation-5 " >
<v-img height=48 width=190 src="/logo.svg"> <v-img class="ml-4" height=48 width=190 src="/logo.svg">
</v-container> </v-container>
<v-container class="ma-0 pa-0 elevation-1"> <v-container class="ma-0 pa-0 elevation-1">
<v-text-field <v-text-field
v-model="q" v-model="q"
style="width: 100%;" style="width: 100%;"
@@ -25,25 +23,25 @@
label="Search" label="Search"
></v-text-field> ></v-text-field>
</v-container> </v-container>
<div class="fancyScroll" style="overflow-y: scroll; overflow-x: hidden; <div class="fancyScroll pa-0 ma-0" style="overflow-y: scroll; overflow-x: hidden;
max-height: 100%;"> max-height: 100%;" >
<v-divider class="grey lighten-1 mr-2 ml-2 mb-4"></v-divider> <v-divider class="grey lighten-1 mr-2 ml-1 mb-4"></v-divider>
<ul class="lefttree">
<li class="lefttree">
<a href="/" class="beba" style="color: #1E1E3C; text-decoration: none;" >
<v-icon style="color: #1E1E3C;" class="mr-1" >home</v-icon> Table of content</a>
</li>
</ul>
<p class="ml-3"> {{ partial "menu_recursive.html" (dict "menu" .Site.Menus.main "page" . "level" 0) }}
<a href="/" class="beba" style="color: #1E1E3C; text-decoration: none!important;" >
<v-icon style="color: #1E1E3C;" >home</v-icon> Table of content</a>
<p>
{{ partial "menu_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }}
<v-divider class="grey lighten-1 ma-2 mt-4 mb-4"></v-divider> <v-divider class="grey lighten-1 ma-2 mt-4 mb-4"></v-divider>
<ul>Have a question ? <ul class="lefttree" >Have a question ?
<li class="lefttree"> <a href="https://forum.pycom.io">Ask on the forum</a> <li class="lefttree"> <a href="https://forum.pycom.io">Ask on the forum</a>
</ul> </ul>
<p>&nbsp;</p> <p>&nbsp;</p>

9
themes/doc-theme/layouts/partials/menu_recursive.html
View File

@@ -1,4 +1,5 @@
{{ $page := .page }} {{ $page := .page }}
{{ $level := add .level 1 }}
{{ $pURL := .page.URL }} {{ $pURL := .page.URL }}
<ul class="lefttree "> <ul class="lefttree ">
{{ range .menu }} {{ range .menu }}
@@ -10,10 +11,11 @@
{{ if true }} {{ if true }}
<li class="lefttree {{ if or $iz $haz }}padleft hot{{ end }}" > <li class="lefttree {{ if or $iz $haz }}padleft hot{{ end }}" >
<a href="{{ .URL | relURL }}" class="{{ if or $iz $haz }}hot{{end}} {{ if $subheading }}mono{{ end }}"> {{ .Pre }} {{ .Name }}</a> <v-icon style="color: transparent; display: hidden;" >done</v-icon>
<a href="{{ .URL | relURL }}" class="{{ if or $iz $haz }}hot{{end}}"> {{ .Pre }} {{ .Name }}</a>
{{ end }} {{ end }}
{{ if or $iz $haz $phaz }} {{ if or $iz $haz $phaz }}
{{ partial "menu_recursive.html" (dict "menu" .Children "page" $page) }} {{ partial "menu_recursive.html" (dict "menu" .Children "page" $page "level" $level ) }}
{{ end }} {{ end }}
{{ if or $iz $haz $phaz}} {{ if or $iz $haz $phaz}}
@@ -24,7 +26,8 @@
<li class="lefttree {{ if $haz }}hot{{end}}"> <li class="lefttree {{ if $haz }}hot{{end}}">
<a href="{{ .URL | relURL }}" class="{{ if $iz }}hot{{end}} {{ if $subheading }}mono{{ end }}">{{ .Name }}</a> <v-icon style="color: transparent; display: hidden;" >done</v-icon>
<a href="{{ .URL | relURL }}" class="{{ if $iz }}hot{{end}}">{{ .Name }}</a>
</li> </li>
{{ end }} {{ end }}

7
themes/doc-theme/layouts/partials/toolbar.html
View File

@@ -7,9 +7,8 @@
dark dark
style="background-color: #171730" style="background-color: #171730"
> >
<!-- style="background-color: #171730" -->
<v-toolbar-title style="width: 260px; " class="ml-4 pl-0 pt-2 text-xs-center hidden-sm-and-down"> <v-toolbar-title style="width: 260px; " class="ml-4 pl-0 pt-2 text-xs-center hidden-sm-and-down">
<v-img height=48 width=190 src="/logo.svg" class=""> <v-img class="ml-4" height=48 width=190 src="/logo.svg" class="">
</v-toolbar-title> </v-toolbar-title>
<v-btn icon @click.stop="drawer = !drawer" style="z-index: 1200;"> <v-btn icon @click.stop="drawer = !drawer" style="z-index: 1200;">
@@ -21,8 +20,8 @@
<v-spacer></v-spacer> <v-spacer></v-spacer>
<div style="width: 235px; background-color: "> <div style="width: 240px; ">
<v-select :items="branches" v-model="branch" class="mono"> <v-select :items="branches" v-model="branch" width=120 class="mono">
</div> </div>
</v-select> </v-select>
{{- if gt .WordCount 400 -}} {{- if gt .WordCount 400 -}}

80
themes/doc-theme/static/css/doc-theme.css
View File

@@ -1,15 +1,12 @@
html { html {
font-size: 105%; font-size: 105%;
} }
.menu-contextual { .menu-contextual {
width: 320px; width: 320px;
right: 0px; right: 0px;
top: 0px; top: 0px;
z-index: 3; z-index: 4;
position: fixed; position: fixed;
} }
@@ -72,30 +69,27 @@ url("/fonts/BebasNeue-Regular.otf") format("opentype");
.application { .application {
/* font-family: 'Beba',Helvetica,Arial,Lucida,sans-serif; */ /* font-family: 'Beba',Helvetica,Arial,Lucida,sans-serif; */
font-family:'Space Mono',monospace; font-family: Helvetica;
} }
/*
p { p {
text-align: justify; text-align: justify;
} }
*/
.bread { .bread {
font-family: 'Beba',Helvetica,Arial,Lucida,sans-serif; font-family: 'Beba',Helvetica,Arial,Lucida,sans-serif;
letter-spacing: 0.1em; letter-spacing: 0.1em;
color: #7800FF; /* color: #7800FF; */
} }
.theme--dark.v-navigation-drawer:not(.v-navigation-drawer--floating) .v-navigation-drawer__border { .theme--dark.v-navigation-drawer:not(.v-navigation-drawer--floating) .v-navigation-drawer__border {
background-color: transparent; background-color: transparent;
} }
/** this gives correct offset when link to anchors
*[id]:before { ul.lefttree {
display: block; margin-left: -8px;
content: " ";
visibility: hidden;
z-index: 0;
} }
*/
a, li.lefttree > a { a, li.lefttree > a {
text-decoration: none; text-decoration: none;
@@ -114,8 +108,12 @@ a:hover {
background-color: yellow; background-color: yellow;
} }
a.v-tabs__item:hover {
background-color: red!important;
}
a { a {
color: #1E1E3C!important; color: #1E1E3C;
} }
li > a { li > a {
@@ -125,18 +123,13 @@ li > a {
} }
li > a.hot { li > a.hot {
color: #7800FF;
text-decoration: underline; text-decoration: underline;
background-color: yellow;
padding: 6px; padding: 6px;
} }
li.lefttree > i {
li.lefttree { display: hidden;
margin-top: 6px;
margin-bottom: 6px;
} }
li.lefttree > a { li.lefttree > a {
@@ -153,31 +146,25 @@ li.hot {
} }
ul.lefttree {
padding-right: 0px;
margin-right: 0px;
}
.v-toolbar__content, .v-toolbar__extension { .v-toolbar__content, .v-toolbar__extension {
padding:0!important; padding:0!important;
} }
.danger-alert { .danger-alert {
background-color: #FF450A !important; background-color: #EF9A9A !important;
margin-top: 24px; margin-top: 24px;
margin-bottom: 24px; margin-bottom: 24px;
} }
.warning-alert { .warning-alert {
background-color: #FF450A !important; background-color: #EF9A9A !important;
margin-top: 24px; margin-top: 24px;
margin-bottom: 24px; margin-bottom: 24px;
} }
.info-alert { .info-alert {
background-color: #00FFFF !important; background-color: #90CAF9 !important;
margin-top: 24px; margin-top: 24px;
margin-bottom: 24px; margin-bottom: 24px;
} }
@@ -197,26 +184,6 @@ img {
padding: 18px; padding: 18px;
} }
/*
nav#TableOfContents::-webkit-scrollbar, .fancyScroll::-webkit-scrollbar
{
width: 10px!important;
}
nav#TableOfContents::-webkit-scrollbar-thumb, .fancyScroll::-webkit-scrollbar-thumb
{
border-radius: 10px!important;
background-image: -webkit-gradient(linear,
left bottom,
left top,
color-stop(0.86, rgb(255,255,255)),
color-stop(0.72, rgb(120,0,255)));
}
*/
[v-cloak] > * { display:none } [v-cloak] > * { display:none }
[v-cloak]::before { [v-cloak]::before {
content: " "; content: " ";
@@ -230,8 +197,6 @@ nav#TableOfContents::-webkit-scrollbar-thumb, .fancyScroll::-webkit-scrollbar-th
background-position: center; background-position: center;
} }
table { table {
display: table; display: table;
width: 100%; width: 100%;
@@ -289,7 +254,6 @@ pre > code {
} }
code { code {
padding: 1px; padding: 1px;
background-color: #EEEEEE; background-color: #EEEEEE;
} }
@@ -297,3 +261,11 @@ code {
.primary--text { .primary--text {
color: #7800FF; color: #7800FF;
} }
.v-window {
padding-top: 24px;
}
p {
text-align: justify;
}