{{ if not .IsHome }}{{ .Title }} —{{ end }} {{ .Site.Title }}

2 |

3 |

4 |

Donate

4 | Consider supporting the authors on Gratipay: 5 | 6 |

Navigation

5 | {{ range .Site.Menus.main }} 6 |

7 | {{ .Name }} 8 |

9 | {{ end }} 10 |

Related Topics

4 |

Documentation overview

Previous: {{ .Title }}
Next: {{ .Title }}

12 | {{- end }} 13 | -------------------------------------------------------------------------------- /theme.toml: -------------------------------------------------------------------------------- 1 | name = "Alabaster" 2 | license = "BSD" 3 | licenselink = "https://github.com/digitalcraftsman/hugo-alabaster-theme/blob/master/LICENSE.md" 4 | description = "A documentation theme ported from Sphinx to Hugo" 5 | homepage = "https://github.com/digitalcraftsman/hugo-alabaster-theme" 6 | tags = ["documentation", "sphinx"] 7 | features = [] 8 | min_version = 0.20 9 | 10 | [author] 11 | name = "Digitalcraftsman" 12 | homepage = "https://github.com/digitalcraftsman" 13 | 14 | # If porting an existing theme 15 | [original] 16 | name = "Jeff Forcier" 17 | homepage = "http://bitprophet.org/" 18 | repo = "https://github.com/bitprophet/alabaster" 19 | -------------------------------------------------------------------------------- /layouts/partials/footer.html: -------------------------------------------------------------------------------- 1 | 9 | 10 | {{ if .Site.Params.github_banner -}} 11 | 12 | Fork me on GitHub

13 | 14 | {{- end }} 15 | -------------------------------------------------------------------------------- /layouts/partials/sidebar/sidebar.html: -------------------------------------------------------------------------------- 1 | 22 |

23 | -------------------------------------------------------------------------------- /exampleSite/config.toml: -------------------------------------------------------------------------------- 1 | baseurl = "https://example.org/" 2 | languageCode = "en-us" 3 | metadataformat = "yaml" 4 | title = "Alabaster" 5 | theme = "hugo-alabaster-theme" 6 | 7 | disqusShortname = "" 8 | googleAnalytics = "" 9 | 10 | [params] 11 | name = "Alabaster" 12 | description = "A documentation theme for Hugo." 13 | 14 | github_user = "digitalcraftsman" 15 | github_repo = "hugo-alabaster-theme" 16 | github_banner = true 17 | 18 | custom_css = [] 19 | custom_js = [] 20 | 21 | highlightjs = "css/highlight.css" 22 | favicon = "favicon.ico" 23 | 24 | [params.sidebar] 25 | logo = "favicon.ico" 26 | 27 | 28 | github_button = true 29 | travis_button = false 30 | codecov_button = false 31 | gratipay = "" 32 | 33 | show_relations = true 34 | 35 | [params.footer] 36 | copyright = "[Digitalcraftsman](https://github.com/digitalcraftsman)" 37 | show_powered_by = true 38 | -------------------------------------------------------------------------------- /layouts/_default/baseof.html: -------------------------------------------------------------------------------- 1 | 3 | 4 | {{ partial "head" . }} 5 | 6 | 7 |

8 |

9 |

10 |

11 | {{ block "main" . }}{{ end }} 12 | 13 | {{ if not .IsHome -}} 14 | {{ template "_internal/disqus.html" . }} 15 | {{- end }} 16 |

17 |

18 |

19 | 20 | {{ partial "sidebar/sidebar" . }} 21 | {{ partial "footer" . }} 22 | 23 | {{ range .Site.Params.custom_js -}} 24 | 25 | {{- end }} 26 | 27 | {{ with .Site.Params.highlightjs -}} 28 | 29 | 30 | {{ end }} 31 | 32 | {{ template "_internal/google_analytics.html" . }} 33 |

34 | 35 | -------------------------------------------------------------------------------- /layouts/partials/sidebar/buttons.html: -------------------------------------------------------------------------------- 1 | {{ if .Site.Params.github_user | and .Site.Params.github_repo -}} 2 | {{ $path := printf "%s/%s" .Site.Params.github_user .Site.Params.github_repo }} 3 | 4 | {{ if .Site.Params.sidebar.github_button -}} 5 |

6 | 8 |

9 | {{- end }} 10 | 11 | {{ if .Site.Params.sidebar.travis_button -}} 12 |

13 | 14 | 18 | 19 |

20 | {{- end }} 21 | 22 | {{ if .Site.Params.sidebar.codecov_button -}} 23 |

24 | 25 | 29 | 30 |

31 | {{- end }} 32 | {{- end }} -------------------------------------------------------------------------------- /layouts/partials/head.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {{ with .Site.Params.description -}} 5 | 6 | {{- end }} 7 | {{ .Hugo.Generator }} 8 | 9 | {{ if not .IsHome }}{{ .Title }} —{{ end }} {{ .Site.Title }} 10 | 11 | 12 | {{ with .Site.Params.highlightjs -}} 13 | 14 | {{- else -}} 15 | 16 | {{- end }} 17 | 18 | {{ range .Site.Params.custom_css -}} 19 | 20 | {{- end }} 21 | 22 | {{ with .Site.Params.favicon -}} 23 | 24 | {{- else -}} 25 | 26 | {{- end }} 27 | -------------------------------------------------------------------------------- /exampleSite/content/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2016-04-23T15:21:22+02:00 3 | title: Foreword 4 | type: homepage 5 | menu: main 6 | weight: 0 7 | --- 8 | 9 | ## What is Alabaster? 10 | 11 | [Alabaster](https://github.com/bitprophet/alabaster) was originally a theme for the popular documentation tool [Sphinx](http://www.sphinx-doc.org/en/stable/). This theme port to Hugo theme is all about documentations. It should allow you to easily create a documentation for your projects. 12 | 13 | [Fabric](http://www.fabfile.org/) and [Invoke](http://www.pyinvoke.org/) are two examples of the Alabaster theme in the wild. 14 | 15 | The following pages will guide you through the setup, introduce you to the very basics of [Hugo](https://gohugo.io) and show you the capabilities of this theme. Have a look at the [Roadmap]({{< relref "roadmap/index.md" >}}) if you're curious about what comes next. 16 | 17 | ## Acknowledgements 18 | 19 | Last but not I want to give a big shout-out to [Jeff Forcier](https://github.com/bitprophet), [Kenneth Reitz](https://github.com/kennethreitz) and [Armin Ronacher](https://github.com/mitsuhiko). Their work and modifications on the original codebase made this port possible. 20 | 21 | Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project. 22 | -------------------------------------------------------------------------------- /static/css/highlight.css: -------------------------------------------------------------------------------- 1 | /* 2 | Description: Foundation 4 docs style for highlight.js 3 | Author: Dan Allen 4 | Website: http://foundation.zurb.com/docs/ 5 | Version: 1.0 6 | Date: 2013-04-02 7 | */ 8 | 9 | .hljs { 10 | display: block; 11 | overflow-x: auto; 12 | } 13 | 14 | .hljs-link, 15 | .hljs-emphasis, 16 | .hljs-attribute, 17 | .hljs-addition { 18 | color: #070; 19 | } 20 | 21 | .hljs-emphasis { 22 | font-style: italic; 23 | } 24 | 25 | .hljs-strong, 26 | .hljs-string, 27 | .hljs-deletion { 28 | color: #d14; 29 | } 30 | 31 | .hljs-strong { 32 | font-weight: bold; 33 | } 34 | 35 | .hljs-quote, 36 | .hljs-comment { 37 | color: #998; 38 | font-style: italic; 39 | } 40 | 41 | .hljs-section, 42 | .hljs-title { 43 | color: #900; 44 | } 45 | 46 | .hljs-class .hljs-title, 47 | .hljs-type { 48 | color: #458; 49 | } 50 | 51 | .hljs-variable, 52 | .hljs-template-variable { 53 | color: #336699; 54 | } 55 | 56 | .hljs-bullet { 57 | color: #997700; 58 | } 59 | 60 | .hljs-meta { 61 | color: #3344bb; 62 | } 63 | 64 | .hljs-code, 65 | .hljs-number, 66 | .hljs-literal, 67 | .hljs-keyword, 68 | .hljs-selector-tag { 69 | color: #099; 70 | } 71 | 72 | .hljs-regexp { 73 | background-color: #fff0ff; 74 | color: #880088; 75 | } 76 | 77 | .hljs-symbol { 78 | color: #990073; 79 | } 80 | 81 | .hljs-tag, 82 | .hljs-name, 83 | .hljs-selector-id, 84 | .hljs-selector-class { 85 | color: #007700; 86 | } -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Copyright (c) 2016 Digitalcraftsman 2 | 3 | Based on original work copyright (c) Jeff Forcier, copyright (c) 2011 Kenneth Reitz 4 | and copyright (c) 2010 Armin Ronacher. 5 | 6 | Some rights reserved. 7 | 8 | Redistribution and use in source and binary forms of the theme, with or 9 | without modification, are permitted provided that the following conditions 10 | are met: 11 | 12 | * Redistributions of source code must retain the above copyright 13 | notice, this list of conditions and the following disclaimer. 14 | 15 | * Redistributions in binary form must reproduce the above 16 | copyright notice, this list of conditions and the following 17 | disclaimer in the documentation and/or other materials provided 18 | with the distribution. 19 | 20 | * The names of the contributors may not be used to endorse or 21 | promote products derived from this software without specific 22 | prior written permission. 23 | 24 | THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 25 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 28 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 29 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 30 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 31 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 32 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 33 | ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE 34 | POSSIBILITY OF SUCH DAMAGE. 35 | -------------------------------------------------------------------------------- /exampleSite/content/roadmap/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2016-04-23T20:08:11+01:00 3 | title: Roadmap 4 | menu: main 5 | weight: 30 6 | --- 7 | 8 | Quo vadis? The port of the original [Alabaster theme](https://github.com/bitprophet/alabaster) has replicated nearly all of its features. A few are still missing, but I've good news: the Hugo community is actively working on this issues. Maybe with the next release of Hugo we can abandon this list. Stay tuned. 9 | 10 | ## Planned features 11 | 12 | ### Localization 13 | 14 | Currently, it is possible to collect all strings in a single place for easy customization. However, this only enables you to define all strings in a single language. This approach is quite limiting in terms of localization support. Therefore, I decided to wait for a native integration. This way we can avoid a second setup of all strings in your website. 15 | 16 | Keep an eye on [#1734](https://github.com/spf13/hugo/issues/1734). 17 | 18 | ### Search 19 | 20 | Beside third-party services, some hacky workarounds and Grunt-/Gulp-based scripts that only require unnecessary dependencies, future versions of Hugo will support the generation of a content index as a core feature. 21 | 22 | Keep an eye on [#1853](https://github.com/spf13/hugo/pull/1853). 23 | 24 | ### Styling options 25 | 26 | The original theme allowed users to customize the layout directly from the [configuration](https://github.com/bitprophet/alabaster#style-colors). There is a similar idea that tries to template CSS stylesheets - this means every stylesheet would be treat as a template that can access the values from your config file. 27 | 28 | Keep an eye on [#1431](https://github.com/spf13/hugo/pull/1431). 29 | 30 | ## Contributing 31 | 32 | Did you found an bug or you would like to suggest a new feature? I'm open for feedback. Please open a new [issue](https://github.com/digitalcraftsman/hugo-alabaster-theme/issues) and let me know what you think. 33 | 34 | You're also welcome to contribute with [pull requests](https://github.com/digitalcraftsman/hugo-alabaster-theme/pulls). -------------------------------------------------------------------------------- /exampleSite/content/adding-content/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2016-04-23T20:26:34+02:00 3 | menu: "main" 4 | title: Adding content 5 | weight: 20 6 | --- 7 | 8 | ## Hello world 9 | 10 | Let's create our first content file for your documentation. Open a terminal and add the following command for each new file you want to add. Replace `` with a general term that describes your document in detail. 11 | 12 | ```sh 13 | hugo new /filename.md 14 | ``` 15 | 16 | Visitors of your website will find the final document under `www.example.com//filename/`. 17 | 18 | Since it's possible to have multiple content files in the same section I recommend to create at least one `index.md` file per section. This ensures that users will find an index page under `www.example.com/`. 19 | 20 | ## Homepage 21 | 22 | To add content to the homepage you need to add a small indicator to the frontmatter of the content file: 23 | 24 | ```toml 25 | type: homepage 26 | ``` 27 | 28 | Otherwise the theme will not be able to find the corresponding content file. 29 | 30 | ## Table of contents 31 | 32 | You maybe noticed that the menu on the left contains a small table of contents of the current page. All `

` tags (`## Headline` in Markdown) will be added automatically. 33 | 34 | ## Admonitions 35 | 36 | Admonition is a handy feature that adds block-styled side content to your documentation, either notes or warnings. It can be enabled by using the corresponding [shortcodes](http://gohugo.io/extras/shortcodes/) inside your content: 37 | 38 | ```md 39 | {{}} 40 | Something good to know. 41 | {{}} 42 | ``` 43 | 44 | will be rendered as 45 | 46 | {{< admonition title="Note" type="note" >}} 47 | Lorem ipsum dolor. 48 | {{< /admonition >}} 49 | 50 | The `type` parameter can optionally be used to either display a `note` or `warning`. The last type is the default one. 51 | 52 | ```md 53 | {{}} 54 | Don't try this at home! 55 | {{}} 56 | ``` 57 | 58 | becomes 59 | 60 | {{< admonition title="Caution" >}} 61 | Don't try this at home! 62 | {{< /admonition >}} 63 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Alabaster 2 | 3 | A documentation theme ported from [Sphinx](http://www.sphinx-doc.org/en/stable/) to [Hugo](https://gohugo.io). 4 | 5 | #### Please note that this theme is no longer maintained. 6 | 7 | [![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-alabaster-theme/dev/images/screenshot.png)](https://digitalcraftsman.github.io/hugo-alabaster-theme/) 8 | 9 | ## Quick start 10 | 11 | Install with `git`: 12 | 13 | ```sh 14 | git clone git@github.com:digitalcraftsman/hugo-alabaster-theme.git themes/hugo-alabaster-theme 15 | ``` 16 | 17 | > This theme uses the latest developement version of Hugo. Therefore, it doesn't work with the official releases. Look [here](https://github.com/spf13/hugo#build-and-install-the-binaries-from-source-advanced-install) if you want to know how to build Hugo from source. 18 | 19 | Next, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation. 20 | 21 | Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary. 22 | 23 | Hugo includes a development server, so you can view your changes as you go - 24 | very handy. Spin it up with the following command: 25 | 26 | ``` sh 27 | hugo server 28 | ``` 29 | 30 | Now you can go to [localhost:1313](http://localhost:1313) and the Alabaster 31 | theme should be visible. 32 | 33 | For detailed installation instructions visit the [demo](https://digitalcraftsman.github.io/hugo-alabaster-theme/). 34 | 35 | ## Acknowledgements 36 | 37 | Last but not I want to give a big shout-out to [Jeff Forcier](https://github.com/bitprophet), [Kenneth Reitz](https://github.com/kennethreitz) and [Armin Ronacher](https://github.com/mitsuhiko). Their work and modifications on the original codebase made this port possible. 38 | 39 | Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project. 40 | 41 | 42 | ## License 43 | 44 | The theme is released under the BSD license. Read the [license](https://github.com/digitalcraftsman/hugo-alabaster-theme/blob/master/LICENSE.md) for more information. 45 | -------------------------------------------------------------------------------- /static/css/pygments.css: -------------------------------------------------------------------------------- 1 | .highlight .hll { background-color: #ffffcc } 2 | .highlight { background: #f8f8f8; } 3 | .highlight .c { color: #8f5902; font-style: italic } /* Comment / 4 | .highlight .err { color: #a40000; border: 1px solid #ef2929 } / Error / 5 | .highlight .g { color: #000000 } / Generic / 6 | .highlight .k { color: #004461; font-weight: bold } / Keyword / 7 | .highlight .l { color: #000000 } / Literal / 8 | .highlight .n { color: #000000 } / Name / 9 | .highlight .o { color: #582800 } / Operator / 10 | .highlight .x { color: #000000 } / Other / 11 | .highlight .p { color: #000000; font-weight: bold } / Punctuation / 12 | .highlight .ch { color: #8f5902; font-style: italic } / Comment.Hashbang / 13 | .highlight .cm { color: #8f5902; font-style: italic } / Comment.Multiline / 14 | .highlight .cp { color: #8f5902 } / Comment.Preproc / 15 | .highlight .cpf { color: #8f5902; font-style: italic } / Comment.PreprocFile / 16 | .highlight .c1 { color: #8f5902; font-style: italic } / Comment.Single / 17 | .highlight .cs { color: #8f5902; font-style: italic } / Comment.Special / 18 | .highlight .gd { color: #a40000 } / Generic.Deleted / 19 | .highlight .ge { color: #000000; font-style: italic } / Generic.Emph / 20 | .highlight .gr { color: #ef2929 } / Generic.Error / 21 | .highlight .gh { color: #000080; font-weight: bold } / Generic.Heading / 22 | .highlight .gi { color: #00A000 } / Generic.Inserted / 23 | .highlight .go { color: #888888 } / Generic.Output / 24 | .highlight .gp { color: #745334 } / Generic.Prompt / 25 | .highlight .gs { color: #000000; font-weight: bold } / Generic.Strong / 26 | .highlight .gu { color: #800080; font-weight: bold } / Generic.Subheading / 27 | .highlight .gt { color: #a40000; font-weight: bold } / Generic.Traceback / 28 | .highlight .kc { color: #004461; font-weight: bold } / Keyword.Constant / 29 | .highlight .kd { color: #004461; font-weight: bold } / Keyword.Declaration / 30 | .highlight .kn { color: #004461; font-weight: bold } / Keyword.Namespace / 31 | .highlight .kp { color: #004461; font-weight: bold } / Keyword.Pseudo / 32 | .highlight .kr { color: #004461; font-weight: bold } / Keyword.Reserved / 33 | .highlight .kt { color: #004461; font-weight: bold } / Keyword.Type / 34 | .highlight .ld { color: #000000 } / Literal.Date / 35 | .highlight .m { color: #990000 } / Literal.Number / 36 | .highlight .s { color: #4e9a06 } / Literal.String / 37 | .highlight .na { color: #c4a000 } / Name.Attribute / 38 | .highlight .nb { color: #004461 } / Name.Builtin / 39 | .highlight .nc { color: #000000 } / Name.Class / 40 | .highlight .no { color: #000000 } / Name.Constant / 41 | .highlight .nd { color: #888888 } / Name.Decorator / 42 | .highlight .ni { color: #ce5c00 } / Name.Entity / 43 | .highlight .ne { color: #cc0000; font-weight: bold } / Name.Exception / 44 | .highlight .nf { color: #000000 } / Name.Function / 45 | .highlight .nl { color: #f57900 } / Name.Label / 46 | .highlight .nn { color: #000000 } / Name.Namespace / 47 | .highlight .nx { color: #000000 } / Name.Other / 48 | .highlight .py { color: #000000 } / Name.Property / 49 | .highlight .nt { color: #004461; font-weight: bold } / Name.Tag / 50 | .highlight .nv { color: #000000 } / Name.Variable / 51 | .highlight .ow { color: #004461; font-weight: bold } / Operator.Word / 52 | .highlight .w { color: #f8f8f8; text-decoration: underline } / Text.Whitespace / 53 | .highlight .mb { color: #990000 } / Literal.Number.Bin / 54 | .highlight .mf { color: #990000 } / Literal.Number.Float / 55 | .highlight .mh { color: #990000 } / Literal.Number.Hex / 56 | .highlight .mi { color: #990000 } / Literal.Number.Integer / 57 | .highlight .mo { color: #990000 } / Literal.Number.Oct / 58 | .highlight .sb { color: #4e9a06 } / Literal.String.Backtick / 59 | .highlight .sc { color: #4e9a06 } / Literal.String.Char / 60 | .highlight .sd { color: #8f5902; font-style: italic } / Literal.String.Doc / 61 | .highlight .s2 { color: #4e9a06 } / Literal.String.Double / 62 | .highlight .se { color: #4e9a06 } / Literal.String.Escape / 63 | .highlight .sh { color: #4e9a06 } / Literal.String.Heredoc / 64 | .highlight .si { color: #4e9a06 } / Literal.String.Interpol / 65 | .highlight .sx { color: #4e9a06 } / Literal.String.Other / 66 | .highlight .sr { color: #4e9a06 } / Literal.String.Regex / 67 | .highlight .s1 { color: #4e9a06 } / Literal.String.Single / 68 | .highlight .ss { color: #4e9a06 } / Literal.String.Symbol / 69 | .highlight .bp { color: #3465a4 } / Name.Builtin.Pseudo / 70 | .highlight .vc { color: #000000 } / Name.Variable.Class / 71 | .highlight .vg { color: #000000 } / Name.Variable.Global / 72 | .highlight .vi { color: #000000 } / Name.Variable.Instance / 73 | .highlight .il { color: #990000 } / Literal.Number.Integer.Long / -------------------------------------------------------------------------------- /exampleSite/content/getting-started/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2016-04-23T15:57:19+02:00 3 | menu: "main" 4 | title: Getting Started 5 | weight: 10 6 | --- 7 | 8 | ## Installation 9 | 10 | ### Install Hugo 11 | 12 | Hugo itself is just a single binary without dependencies on expensive runtimes like Ruby, Python or PHP and without dependencies on any databases. 13 | 14 | {{< admonition title="Note" type="note" >}} 15 | Currently, this theme makes use of features that will be part of the Hugo v0.16 release. You have to [compile](https://github.com/spf13/hugo/#clone-the-hugo-project-contributor) the latest developement version yourself. 16 | {{< /admonition >}} 17 | 18 | 19 | 20 | Let's make sure Hugo is set up as expected. You should see a similar version number in your terminal: 21 | 22 | ```sh 23 | hugo version 24 | # Hugo Static Site Generator v0.15 BuildDate: 2016-01-03T12:47:47+01:00 25 | ``` 26 | 27 | ### Install Alabaster 28 | 29 | Next, assuming you have Hugo up and running the `hugo-alabaster` theme can be installed with `git`: 30 | 31 | ```sh 32 | # create a new Hugo website 33 | hugo new site my-awesome-docs 34 | 35 | # move into the themes folder of your website 36 | cd my-awesome-docs/themes/ 37 | 38 | # download the theme 39 | git clone git@github.com:digitalcraftsman/hugo-alabaster-theme.git 40 | ``` 41 | 42 | ## Setup 43 | 44 | Next, take a look in the `exampleSite` folder at `themes/hugo-alabaster-theme/`. This directory contains an example config file and the content that you are currently reading. It serves as an example setup for your documentation. 45 | 46 | Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary. 47 | 48 | Hugo includes a development server, so you can view your changes as you go - 49 | very handy. Spin it up with the following command: 50 | 51 | ```sh 52 | hugo server 53 | ``` 54 | 55 | Now you can go to [localhost:1313](http://localhost:1313) and the Alabaster 56 | theme should be visible. You can now start writing your documentation, or read 57 | on and customize the theme through some options. 58 | 59 | ## Configuration 60 | 61 | Before you are able to deploy your documentation you should take a few minute to adjust some information in the `config.toml`. Open the file in an editor: 62 | 63 | ```toml 64 | baseurl = "http://replace-this-with-your-hugo-site.com/" 65 | languageCode = "en-us" 66 | title = "Alabaster" 67 | 68 | disqusShortname = "" 69 | googleAnalytics = "" 70 | 71 | [params] 72 | name = "Alabaster" 73 | description = "A documentation theme for Hugo." 74 | ``` 75 | 76 | Add some metadata about your theme. The `name` and `description` will appear in the top left of the sidebar. Furthermore, you can enable tracking via Google Analytics by entering your tracking code. 77 | 78 | To allow users direct feedback to your documentation you can also enable a comment section powered by Disqus. The comment section will appear on each page except the homepage. 79 | 80 | 81 | ## Options 82 | 83 | ### Adding a custom favicon 84 | 85 | Favicons are small small icons that are displayed in the tabs right next to the title of the current page. As with the logo above you need to save your favicon in `static/` and link it relative to this folder in the config file: 86 | 87 | ```toml 88 | [params] 89 | favicon = "favicon.ico" 90 | ``` 91 | 92 | ### Syntax highlighting 93 | 94 | This theme uses the popular [Highlight.js](https://highlightjs.org/) library to colorize code examples. The default theme is called "Foundation" with a few small tweaks. You can link our own theme if you like. Again, store your stylesheet in the `static/` folder and set the relative path in the config file: 95 | 96 | ```toml 97 | [params] 98 | # Syntax highlighting theme 99 | highlightjs = "path/to/theme.css" 100 | ``` 101 | 102 | Alternatively, you can use Pygments to highlight code blocks. If `highlightjs` does not contain a path it defaults to the Pygments stylesheet. Read the [Hugo docs](https://gohugo.io/extras/highlighting#pygments) for more information. 103 | 104 | If you used GitHub flavoured Markdown with code fences like below 105 | 106 | ```` 107 | ```toml 108 | [params] 109 | # Syntax highlighting theme 110 | highlightjs = "path/to/theme.css" 111 | ``` 112 | ```` 113 | 114 | you have to add the `pygmentsuseclasses = true` option to the config file. 115 | 116 | ### Small tweaks 117 | 118 | This theme provides a simple way for making small adjustments, that is changing some margins, centering text, etc. Simply put the CSS and Javascript files that contain your adjustments in the `static/` directory (ideally in subdirectories of their own) and include them via the `custom_css` and `custom_js` 119 | variables in your `config.toml`. Reference the files relative to `static/`: 120 | 121 | ```toml 122 | [params] 123 | custom_css = [ 124 | "foo.css", 125 | "bar.css" 126 | ] 127 | 128 | custom_js = ["buzz.js"] 129 | ``` 130 | 131 | 132 | ## Sidebar 133 | 134 | ### Adding a logo 135 | 136 | If your project has a logo, you can add it to the sidebar by defining the variable `logo`. Save your logo somewhere in the `static/` folder and reference the file relative to this location: 137 | 138 | ```toml 139 | [params.sidebar] 140 | logo = "images/logo.png" 141 | ``` 142 | 143 | ### Adding menu entries 144 | 145 | Once you created your first content files you can link them manually in the sidebar on the left. A menu entry has the following schema: 146 | 147 | ```toml 148 | [[menu.main]] 149 | name = "Home" 150 | url = "/" 151 | weight = 0 152 | ``` 153 | 154 | `name` is the title displayed in the menu and `url` the relative URL to the content. The `weight` attribute allows you to modify the order of the menu entries. A menu entry appears further down the more weight you add. 155 | 156 | Instead of just linking a single file you can enhance the sidebar by creating a nested menu. This way you can list all pages of a section instead of linking them one by one (without nesting). 157 | 158 | You need extend the frontmatter of each file content file in a section slightly. The snippet below registers this content file as 'child' of a menu entry that already exists. 159 | 160 | ```yaml 161 | menu: main 162 | weight: 0 163 | ``` 164 | 165 | `main` specifies to which menu the content file should be added. `main` is the only menu in this theme by default. `parent` let's you register this content file to an existing menu entry, in this case the `Home` link. Note that the parent in the frontmatter needs to match the name in `config.toml`. 166 | 167 | ### Buttons 168 | 169 | Above the menu you can include multiple buttons, e.g. the number of stars on GitHub or the current build status of [TravisCI](https://travis-ci.org/). 170 | 171 | {{< admonition title="Note" type="note" >}} 172 | It is required that you add your username and the URL to the project you want to document. Otherwise the buttons will not be able to display any information. 173 | {{< /admonition >}} 174 | 175 | If your project is hosted on GitHub, add the repository link and your username to the 176 | configuration. 177 | 178 | ```toml 179 | [params] 180 | github_user = "digitalcraftsman" 181 | github_repo = "hugo-alabaster-theme" 182 | github_banner = true 183 | ``` 184 | 185 | `github_banner` adds the black banner in the top right of each page and simply links to your project on GitHub. 186 | 187 | Now you can define which buttons you want to show: 188 | 189 | ```toml 190 | [params.sidebar] 191 | github_button = true 192 | travis_button = false 193 | codecov_button = false 194 | gratipay = "" 195 | ``` 196 | 197 | 1. `github_button` displays the number of stars of your repository on GitHub 198 | 1. `travis_button` displays the current build status of your project 199 | 1. `codecov_button` display the code coverage of your tests thanks to [CodeCov](https://codecov.io/) 200 | 1. `gratipay` allows you to collect tips via [GratiPay](https://gratipay.com/). Enter your username after you signed up. 201 | 202 | 203 | ### Relations 204 | 205 | Includes links to the previous and next page in a section those exist under the menu as "Related Topics". This makes the navigation for users easier. It can be disabled if each of your website section's contain only contain a single page. 206 | 207 | ```toml 208 | [params.sidebar] 209 | show_relations = true 210 | ``` 211 | 212 | ## Footer 213 | 214 | The footer is very simple. Your `copyright` notice can be formatted with Markdown. This can be handy if you want to format text slightly or you want to include a hyperlink. 215 | 216 | `show_powered_by` allows you hide the showcase of the used tools. Some promotion is always appreciated. 217 | 218 | ```toml 219 | [params.footer] 220 | copyright = "[Digitalcraftsman](https://github.com/digitalcraftsman)" 221 | show_powered_by = true 222 | ``` -------------------------------------------------------------------------------- /static/css/alabaster.css: -------------------------------------------------------------------------------- 1 | @import url("basic.css"); 2 | 3 | / -- page layout ----------------------------------------------------------- / 4 | 5 | body { 6 | font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif; 7 | font-size: 17px; 8 | background-color: white; 9 | color: #000; 10 | margin: 0; 11 | padding: 0; 12 | } 13 | 14 | div.document { 15 | width: 940px; 16 | margin: 30px auto 0 auto; 17 | } 18 | 19 | div.documentwrapper { 20 | float: left; 21 | width: 100%; 22 | } 23 | 24 | div.bodywrapper { 25 | margin: 0 0 0 220px; 26 | } 27 | 28 | div.sphinxsidebar { 29 | width: 220px; 30 | } 31 | 32 | hr { 33 | border: 1px solid #B1B4B6; 34 | } 35 | 36 | div.body { 37 | background-color: #ffffff; 38 | color: #3E4349; 39 | padding: 0 30px 0 30px; 40 | } 41 | 42 | div.body > .section { 43 | text-align: left; 44 | } 45 | 46 | div.footer { 47 | width: 940px; 48 | margin: 20px auto 30px auto; 49 | font-size: 14px; 50 | color: #888; 51 | text-align: right; 52 | } 53 | 54 | div.footer a { 55 | color: #888; 56 | } 57 | 58 | 59 | div.relations { 60 | display: none; 61 | } 62 | 63 | 64 | div.sphinxsidebar a { 65 | color: #444; 66 | text-decoration: none; 67 | border-bottom: 1px dotted #999; 68 | } 69 | 70 | div.sphinxsidebar a:hover { 71 | border-bottom: 1px solid #999; 72 | } 73 | 74 | div.sphinxsidebar { 75 | font-size: 14px; 76 | line-height: 1.5; 77 | } 78 | 79 | div.sphinxsidebarwrapper { 80 | padding: 18px 10px; 81 | } 82 | 83 | div.sphinxsidebarwrapper p.logo { 84 | padding: 0; 85 | margin: -10px 0 0 0px; 86 | text-align: center; 87 | } 88 | 89 | div.sphinxsidebarwrapper h1.logo { 90 | margin-top: -10px; 91 | text-align: center; 92 | margin-bottom: 5px; 93 | text-align: center; 94 | } 95 | 96 | div.sphinxsidebarwrapper h1.logo-name { 97 | margin-top: 0px; 98 | } 99 | 100 | div.sphinxsidebarwrapper p.blurb { 101 | margin-top: 0; 102 | font-style: normal; 103 | } 104 | 105 | div.sphinxsidebar h3, 106 | div.sphinxsidebar h4 { 107 | font-family: 'Garamond', 'Georgia', serif; 108 | color: #444; 109 | font-size: 24px; 110 | font-weight: normal; 111 | margin: 0 0 5px 0; 112 | padding: 0; 113 | } 114 | 115 | div.sphinxsidebar h4 { 116 | font-size: 20px; 117 | } 118 | 119 | div.sphinxsidebar h3 a { 120 | color: #444; 121 | } 122 | 123 | div.sphinxsidebar p.logo a, 124 | div.sphinxsidebar h3 a, 125 | div.sphinxsidebar p.logo a:hover, 126 | div.sphinxsidebar h3 a:hover { 127 | border: none; 128 | } 129 | 130 | div.sphinxsidebar p { 131 | color: #555; 132 | margin: 10px 0; 133 | } 134 | 135 | div.sphinxsidebar ul { 136 | margin: 10px 0; 137 | padding: 0; 138 | color: #000; 139 | } 140 | 141 | div.sphinxsidebar ul li.toctree-l1 > a { 142 | font-size: 120%; 143 | } 144 | 145 | div.sphinxsidebar ul li.toctree-l2 > a { 146 | font-size: 110%; 147 | } 148 | 149 | div.sphinxsidebar input { 150 | border: 1px solid #CCC; 151 | font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif; 152 | font-size: 1em; 153 | } 154 | 155 | div.sphinxsidebar hr { 156 | border: none; 157 | height: 1px; 158 | color: #AAA; 159 | background: #AAA; 160 | 161 | text-align: left; 162 | margin-left: 0; 163 | width: 50%; 164 | } 165 | 166 | / -- body styles ----------------------------------------------------------- / 167 | 168 | a { 169 | color: #3782BE; 170 | text-decoration: underline; 171 | } 172 | 173 | a:hover { 174 | color: #3782BE; 175 | text-decoration: underline; 176 | } 177 | 178 | div.body h1, 179 | div.body h2, 180 | div.body h3, 181 | div.body h4, 182 | div.body h5, 183 | div.body h6 { 184 | font-family: 'Garamond', 'Georgia', serif; 185 | font-weight: normal; 186 | margin: 30px 0px 10px 0px; 187 | padding: 0; 188 | } 189 | 190 | div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } 191 | div.body h2 { font-size: 180%; } 192 | div.body h3 { font-size: 150%; } 193 | div.body h4 { font-size: 130%; } 194 | div.body h5 { font-size: 100%; } 195 | div.body h6 { font-size: 100%; } 196 | 197 | a.headerlink { 198 | color: #DDD; 199 | padding: 0 4px; 200 | text-decoration: none; 201 | } 202 | 203 | a.headerlink:hover { 204 | color: #444; 205 | background: #EAEAEA; 206 | } 207 | 208 | div.body p, div.body dd, div.body li { 209 | line-height: 1.4em; 210 | } 211 | 212 | div.admonition { 213 | margin: 20px 0px; 214 | padding: 10px 30px; 215 | background-color: #FCC; 216 | border: 1px solid #FAA; 217 | } 218 | 219 | div.admonition tt.xref, div.admonition a tt { 220 | border-bottom: 1px solid #fafafa; 221 | } 222 | 223 | dd div.admonition { 224 | margin-left: -60px; 225 | padding-left: 60px; 226 | } 227 | 228 | div.admonition p.admonition-title { 229 | font-family: 'Garamond', 'Georgia', serif; 230 | font-weight: normal; 231 | font-size: 24px; 232 | margin: 0 0 10px 0; 233 | padding: 0; 234 | line-height: 1; 235 | } 236 | 237 | div.admonition p.last { 238 | margin-bottom: 0; 239 | } 240 | 241 | div.highlight { 242 | background-color: white; 243 | } 244 | 245 | dt:target, .highlight { 246 | background: #FAF3E8; 247 | } 248 | 249 | div.note { 250 | background-color: #EEE; 251 | border: 1px solid #CCC; 252 | } 253 | 254 | div.seealso { 255 | background-color: #EEE; 256 | border: 1px solid #CCC; 257 | } 258 | 259 | div.topic { 260 | background-color: #eee; 261 | } 262 | 263 | p.admonition-title { 264 | display: inline; 265 | } 266 | 267 | p.admonition-title:after { 268 | content: ":"; 269 | } 270 | 271 | pre, tt, code { 272 | font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; 273 | font-size: 0.9em; 274 | } 275 | 276 | .hll { 277 | background-color: #FFC; 278 | margin: 0 -12px; 279 | padding: 0 12px; 280 | display: block; 281 | } 282 | 283 | img.screenshot { 284 | } 285 | 286 | tt.descname, tt.descclassname, code.descname, code.descclassname { 287 | font-size: 0.95em; 288 | } 289 | 290 | tt.descname, code.descname { 291 | padding-right: 0.08em; 292 | } 293 | 294 | img.screenshot { 295 | -moz-box-shadow: 2px 2px 4px #eee; 296 | -webkit-box-shadow: 2px 2px 4px #eee; 297 | box-shadow: 2px 2px 4px #eee; 298 | } 299 | 300 | table.docutils { 301 | border: 1px solid #888; 302 | -moz-box-shadow: 2px 2px 4px #eee; 303 | -webkit-box-shadow: 2px 2px 4px #eee; 304 | box-shadow: 2px 2px 4px #eee; 305 | } 306 | 307 | table.docutils td, table.docutils th { 308 | border: 1px solid #888; 309 | padding: 0.25em 0.7em; 310 | } 311 | 312 | table.field-list, table.footnote { 313 | border: none; 314 | -moz-box-shadow: none; 315 | -webkit-box-shadow: none; 316 | box-shadow: none; 317 | } 318 | 319 | table.footnote { 320 | margin: 15px 0; 321 | width: 100%; 322 | border: 1px solid #EEE; 323 | background: #FDFDFD; 324 | font-size: 0.9em; 325 | } 326 | 327 | table.footnote + table.footnote { 328 | margin-top: -15px; 329 | border-top: none; 330 | } 331 | 332 | table.field-list th { 333 | padding: 0 0.8em 0 0; 334 | } 335 | 336 | table.field-list td { 337 | padding: 0; 338 | } 339 | 340 | table.field-list p { 341 | margin-bottom: 0.8em; 342 | } 343 | 344 | table.footnote td.label { 345 | width: 0px; 346 | padding: 0.3em 0 0.3em 0.5em; 347 | } 348 | 349 | table.footnote td { 350 | padding: 0.3em 0.5em; 351 | } 352 | 353 | dl { 354 | margin: 0; 355 | padding: 0; 356 | } 357 | 358 | dl dd { 359 | margin-left: 30px; 360 | } 361 | 362 | blockquote { 363 | margin: 0 0 0 30px; 364 | padding: 0; 365 | } 366 | 367 | ul, ol { 368 | margin: 10px 0 10px 30px; 369 | padding: 0; 370 | } 371 | 372 | pre { 373 | background: #EEE; 374 | padding: 7px 30px; 375 | margin: 15px 0px; 376 | line-height: 1.3em; 377 | } 378 | 379 | dl pre, blockquote pre, li pre { 380 | margin-left: 0; 381 | padding-left: 30px; 382 | } 383 | 384 | dl dl pre { 385 | margin-left: -90px; 386 | padding-left: 90px; 387 | } 388 | 389 | tt, code { 390 | background-color: #ecf0f3; 391 | color: #222; 392 | / padding: 1px 2px; / 393 | } 394 | 395 | tt.xref, code.xref, a tt { 396 | background-color: #FBFBFB; 397 | border-bottom: 1px solid white; 398 | } 399 | 400 | a.reference { 401 | text-decoration: none; 402 | border-bottom: 1px dotted #3782BE; 403 | } 404 | 405 | a.reference:hover { 406 | border-bottom: 1px solid #3782BE; 407 | } 408 | 409 | a.footnote-reference { 410 | text-decoration: none; 411 | font-size: 0.7em; 412 | vertical-align: top; 413 | border-bottom: 1px dotted #3782BE; 414 | } 415 | 416 | a.footnote-reference:hover { 417 | border-bottom: 1px solid #3782BE; 418 | } 419 | 420 | a:hover tt, a:hover code { 421 | background: #EEE; 422 | } 423 | 424 | 425 | @media screen and (max-width: 870px) { 426 | 427 | div.sphinxsidebar { 428 | display: none; 429 | } 430 | 431 | div.document { 432 | width: 100%; 433 | 434 | } 435 | 436 | div.documentwrapper { 437 | margin-left: 0; 438 | margin-top: 0; 439 | margin-right: 0; 440 | margin-bottom: 0; 441 | } 442 | 443 | div.bodywrapper { 444 | margin-top: 0; 445 | margin-right: 0; 446 | margin-bottom: 0; 447 | margin-left: 0; 448 | } 449 | 450 | ul { 451 | margin-left: 0; 452 | } 453 | 454 | .document { 455 | width: auto; 456 | } 457 | 458 | .footer { 459 | width: auto; 460 | } 461 | 462 | .bodywrapper { 463 | margin: 0; 464 | } 465 | 466 | .footer { 467 | width: auto; 468 | } 469 | 470 | .github { 471 | display: none; 472 | } 473 | 474 | 475 | 476 | } 477 | 478 | 479 | 480 | @media screen and (max-width: 875px) { 481 | 482 | body { 483 | margin: 0; 484 | padding: 20px 30px; 485 | } 486 | 487 | div.documentwrapper { 488 | float: none; 489 | background: white; 490 | } 491 | 492 | div.sphinxsidebar { 493 | display: block; 494 | float: none; 495 | width: 102.5%; 496 | margin: 50px -30px -20px -30px; 497 | padding: 10px 20px; 498 | background: #333; 499 | color: #FFF; 500 | } 501 | 502 | div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, 503 | div.sphinxsidebar h3 a { 504 | color: white; 505 | } 506 | 507 | div.sphinxsidebar a { 508 | color: #AAA; 509 | } 510 | 511 | div.sphinxsidebar p.logo { 512 | display: none; 513 | } 514 | 515 | div.document { 516 | width: 100%; 517 | margin: 0; 518 | } 519 | 520 | div.footer { 521 | display: none; 522 | } 523 | 524 | div.bodywrapper { 525 | margin: 0; 526 | } 527 | 528 | div.body { 529 | min-height: 0; 530 | padding: 0; 531 | } 532 | 533 | .rtd_doc_footer { 534 | display: none; 535 | } 536 | 537 | .document { 538 | width: auto; 539 | } 540 | 541 | .footer { 542 | width: auto; 543 | } 544 | 545 | .footer { 546 | width: auto; 547 | } 548 | 549 | .github { 550 | display: none; 551 | } 552 | } 553 | 554 | 555 | / misc. / 556 | 557 | .revsys-inline { 558 | display: none!important; 559 | } 560 | 561 | / Make nested-list/multi-paragraph items look better in Releases changelog 562 | * pages. Without this, docutils' magical list fuckery causes inconsistent 563 | * formatting between different release sub-lists. 564 | / 565 | div#changelog > div.section > ul > li > p:only-child { 566 | margin-bottom: 0; 567 | } 568 | 569 | / Hide fugly table cell borders in ..bibliography:: directive output / 570 | table.docutils.citation, table.docutils.citation td, table.docutils.citation th { 571 | border: none; 572 | / Below needed in some edge cases; if not applied, bottom shadows appear / 573 | -moz-box-shadow: none; 574 | -webkit-box-shadow: none; 575 | box-shadow: none; 576 | } -------------------------------------------------------------------------------- /static/css/basic.css: -------------------------------------------------------------------------------- 1 | / 2 | * basic.css 3 | * ~~~~~~~~~ 4 | * 5 | * Sphinx stylesheet -- basic theme. 6 | * 7 | * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | / 11 | 12 | / -- main layout ----------------------------------------------------------- / 13 | 14 | div.clearer { 15 | clear: both; 16 | } 17 | 18 | / -- relbar ---------------------------------------------------------------- / 19 | 20 | div.related { 21 | width: 100%; 22 | font-size: 90%; 23 | } 24 | 25 | div.related h3 { 26 | display: none; 27 | } 28 | 29 | div.related ul { 30 | margin: 0; 31 | padding: 0 0 0 10px; 32 | list-style: none; 33 | } 34 | 35 | div.related li { 36 | display: inline; 37 | } 38 | 39 | div.related li.right { 40 | float: right; 41 | margin-right: 5px; 42 | } 43 | 44 | / -- sidebar --------------------------------------------------------------- / 45 | 46 | div.sphinxsidebarwrapper { 47 | padding: 10px 5px 0 10px; 48 | } 49 | 50 | div.sphinxsidebar { 51 | float: left; 52 | width: 230px; 53 | margin-left: -100%; 54 | font-size: 90%; 55 | } 56 | 57 | div.sphinxsidebar ul { 58 | list-style: none; 59 | } 60 | 61 | div.sphinxsidebar ul ul, 62 | div.sphinxsidebar ul.want-points { 63 | margin-left: 20px; 64 | list-style: square; 65 | } 66 | 67 | div.sphinxsidebar ul ul { 68 | margin-top: 0; 69 | margin-bottom: 0; 70 | } 71 | 72 | div.sphinxsidebar form { 73 | margin-top: 10px; 74 | } 75 | 76 | div.sphinxsidebar input { 77 | border: 1px solid #98dbcc; 78 | font-family: sans-serif; 79 | font-size: 1em; 80 | } 81 | 82 | div.sphinxsidebar #searchbox input[type="text"] { 83 | width: 170px; 84 | } 85 | 86 | div.sphinxsidebar #searchbox input[type="submit"] { 87 | width: 30px; 88 | } 89 | 90 | img { 91 | border: 0; 92 | max-width: 100%; 93 | } 94 | 95 | / -- search page ----------------------------------------------------------- / 96 | 97 | ul.search { 98 | margin: 10px 0 0 20px; 99 | padding: 0; 100 | } 101 | 102 | ul.search li { 103 | padding: 5px 0 5px 20px; 104 | background-image: url(file.png); 105 | background-repeat: no-repeat; 106 | background-position: 0 7px; 107 | } 108 | 109 | ul.search li a { 110 | font-weight: bold; 111 | } 112 | 113 | ul.search li div.context { 114 | color: #888; 115 | margin: 2px 0 0 30px; 116 | text-align: left; 117 | } 118 | 119 | ul.keywordmatches li.goodmatch a { 120 | font-weight: bold; 121 | } 122 | 123 | / -- index page ------------------------------------------------------------ / 124 | 125 | table.contentstable { 126 | width: 90%; 127 | } 128 | 129 | table.contentstable p.biglink { 130 | line-height: 150%; 131 | } 132 | 133 | a.biglink { 134 | font-size: 1.3em; 135 | } 136 | 137 | span.linkdescr { 138 | font-style: italic; 139 | padding-top: 5px; 140 | font-size: 90%; 141 | } 142 | 143 | / -- general index --------------------------------------------------------- / 144 | 145 | table.indextable { 146 | width: 100%; 147 | } 148 | 149 | table.indextable td { 150 | text-align: left; 151 | vertical-align: top; 152 | } 153 | 154 | table.indextable dl, table.indextable dd { 155 | margin-top: 0; 156 | margin-bottom: 0; 157 | } 158 | 159 | table.indextable tr.pcap { 160 | height: 10px; 161 | } 162 | 163 | table.indextable tr.cap { 164 | margin-top: 10px; 165 | background-color: #f2f2f2; 166 | } 167 | 168 | img.toggler { 169 | margin-right: 3px; 170 | margin-top: 3px; 171 | cursor: pointer; 172 | } 173 | 174 | div.modindex-jumpbox { 175 | border-top: 1px solid #ddd; 176 | border-bottom: 1px solid #ddd; 177 | margin: 1em 0 1em 0; 178 | padding: 0.4em; 179 | } 180 | 181 | div.genindex-jumpbox { 182 | border-top: 1px solid #ddd; 183 | border-bottom: 1px solid #ddd; 184 | margin: 1em 0 1em 0; 185 | padding: 0.4em; 186 | } 187 | 188 | / -- general body styles --------------------------------------------------- / 189 | 190 | a.headerlink { 191 | visibility: hidden; 192 | } 193 | 194 | h1:hover > a.headerlink, 195 | h2:hover > a.headerlink, 196 | h3:hover > a.headerlink, 197 | h4:hover > a.headerlink, 198 | h5:hover > a.headerlink, 199 | h6:hover > a.headerlink, 200 | dt:hover > a.headerlink, 201 | caption:hover > a.headerlink, 202 | p.caption:hover > a.headerlink, 203 | div.code-block-caption:hover > a.headerlink { 204 | visibility: visible; 205 | } 206 | 207 | div.body p.caption { 208 | text-align: inherit; 209 | } 210 | 211 | div.body td { 212 | text-align: left; 213 | } 214 | 215 | .field-list ul { 216 | padding-left: 1em; 217 | } 218 | 219 | .first { 220 | margin-top: 0 !important; 221 | } 222 | 223 | p.rubric { 224 | margin-top: 30px; 225 | font-weight: bold; 226 | } 227 | 228 | img.align-left, .figure.align-left, object.align-left { 229 | clear: left; 230 | float: left; 231 | margin-right: 1em; 232 | } 233 | 234 | img.align-right, .figure.align-right, object.align-right { 235 | clear: right; 236 | float: right; 237 | margin-left: 1em; 238 | } 239 | 240 | img.align-center, .figure.align-center, object.align-center { 241 | display: block; 242 | margin-left: auto; 243 | margin-right: auto; 244 | } 245 | 246 | .align-left { 247 | text-align: left; 248 | } 249 | 250 | .align-center { 251 | text-align: center; 252 | } 253 | 254 | .align-right { 255 | text-align: right; 256 | } 257 | 258 | / -- sidebars -------------------------------------------------------------- / 259 | 260 | div.sidebar { 261 | margin: 0 0 0.5em 1em; 262 | border: 1px solid #ddb; 263 | padding: 7px 7px 0 7px; 264 | background-color: #ffe; 265 | width: 40%; 266 | float: right; 267 | } 268 | 269 | p.sidebar-title { 270 | font-weight: bold; 271 | } 272 | 273 | / -- topics ---------------------------------------------------------------- / 274 | 275 | div.topic { 276 | border: 1px solid #ccc; 277 | padding: 7px 7px 0 7px; 278 | margin: 10px 0 10px 0; 279 | } 280 | 281 | p.topic-title { 282 | font-size: 1.1em; 283 | font-weight: bold; 284 | margin-top: 10px; 285 | } 286 | 287 | / -- admonitions ----------------------------------------------------------- / 288 | 289 | div.admonition { 290 | margin-top: 10px; 291 | margin-bottom: 10px; 292 | padding: 7px; 293 | } 294 | 295 | div.admonition dt { 296 | font-weight: bold; 297 | } 298 | 299 | div.admonition dl { 300 | margin-bottom: 0; 301 | } 302 | 303 | p.admonition-title { 304 | margin: 0px 10px 5px 0px; 305 | font-weight: bold; 306 | } 307 | 308 | div.body p.centered { 309 | text-align: center; 310 | margin-top: 25px; 311 | } 312 | 313 | / -- tables ---------------------------------------------------------------- / 314 | 315 | table.docutils { 316 | border: 0; 317 | border-collapse: collapse; 318 | } 319 | 320 | table caption span.caption-number { 321 | font-style: italic; 322 | } 323 | 324 | table caption span.caption-text { 325 | } 326 | 327 | table.docutils td, table.docutils th { 328 | padding: 1px 8px 1px 5px; 329 | border-top: 0; 330 | border-left: 0; 331 | border-right: 0; 332 | border-bottom: 1px solid #aaa; 333 | } 334 | 335 | table.field-list td, table.field-list th { 336 | border: 0 !important; 337 | } 338 | 339 | table.footnote td, table.footnote th { 340 | border: 0 !important; 341 | } 342 | 343 | th { 344 | text-align: left; 345 | padding-right: 5px; 346 | } 347 | 348 | table.citation { 349 | border-left: solid 1px gray; 350 | margin-left: 1px; 351 | } 352 | 353 | table.citation td { 354 | border-bottom: none; 355 | } 356 | 357 | / -- figures --------------------------------------------------------------- / 358 | 359 | div.figure { 360 | margin: 0.5em; 361 | padding: 0.5em; 362 | } 363 | 364 | div.figure p.caption { 365 | padding: 0.3em; 366 | } 367 | 368 | div.figure p.caption span.caption-number { 369 | font-style: italic; 370 | } 371 | 372 | div.figure p.caption span.caption-text { 373 | } 374 | 375 | 376 | / -- other body styles ----------------------------------------------------- / 377 | 378 | ol.arabic { 379 | list-style: decimal; 380 | } 381 | 382 | ol.loweralpha { 383 | list-style: lower-alpha; 384 | } 385 | 386 | ol.upperalpha { 387 | list-style: upper-alpha; 388 | } 389 | 390 | ol.lowerroman { 391 | list-style: lower-roman; 392 | } 393 | 394 | ol.upperroman { 395 | list-style: upper-roman; 396 | } 397 | 398 | dl { 399 | margin-bottom: 15px; 400 | } 401 | 402 | dd p { 403 | margin-top: 0px; 404 | } 405 | 406 | dd ul, dd table { 407 | margin-bottom: 10px; 408 | } 409 | 410 | dd { 411 | margin-top: 3px; 412 | margin-bottom: 10px; 413 | margin-left: 30px; 414 | } 415 | 416 | dt:target, .highlighted { 417 | background-color: #fbe54e; 418 | } 419 | 420 | dl.glossary dt { 421 | font-weight: bold; 422 | font-size: 1.1em; 423 | } 424 | 425 | .field-list ul { 426 | margin: 0; 427 | padding-left: 1em; 428 | } 429 | 430 | .field-list p { 431 | margin: 0; 432 | } 433 | 434 | .optional { 435 | font-size: 1.3em; 436 | } 437 | 438 | .sig-paren { 439 | font-size: larger; 440 | } 441 | 442 | .versionmodified { 443 | font-style: italic; 444 | } 445 | 446 | .system-message { 447 | background-color: #fda; 448 | padding: 5px; 449 | border: 3px solid red; 450 | } 451 | 452 | .footnote:target { 453 | background-color: #ffa; 454 | } 455 | 456 | .line-block { 457 | display: block; 458 | margin-top: 1em; 459 | margin-bottom: 1em; 460 | } 461 | 462 | .line-block .line-block { 463 | margin-top: 0; 464 | margin-bottom: 0; 465 | margin-left: 1.5em; 466 | } 467 | 468 | .guilabel, .menuselection { 469 | font-family: sans-serif; 470 | } 471 | 472 | .accelerator { 473 | text-decoration: underline; 474 | } 475 | 476 | .classifier { 477 | font-style: oblique; 478 | } 479 | 480 | abbr, acronym { 481 | border-bottom: dotted 1px; 482 | cursor: help; 483 | } 484 | 485 | / -- code displays --------------------------------------------------------- / 486 | 487 | pre { 488 | overflow: auto; 489 | overflow-y: hidden; / fixes display issues on Chrome browsers / 490 | } 491 | 492 | td.linenos pre { 493 | padding: 5px 0px; 494 | border: 0; 495 | background-color: transparent; 496 | color: #aaa; 497 | } 498 | 499 | table.highlighttable { 500 | margin-left: 0.5em; 501 | } 502 | 503 | table.highlighttable td { 504 | padding: 0 0.5em 0 0.5em; 505 | } 506 | 507 | div.code-block-caption { 508 | padding: 2px 5px; 509 | font-size: small; 510 | } 511 | 512 | div.code-block-caption code { 513 | background-color: transparent; 514 | } 515 | 516 | div.code-block-caption + div > div.highlight > pre { 517 | margin-top: 0; 518 | } 519 | 520 | div.code-block-caption span.caption-number { 521 | padding: 0.1em 0.3em; 522 | font-style: italic; 523 | } 524 | 525 | div.code-block-caption span.caption-text { 526 | } 527 | 528 | div.literal-block-wrapper { 529 | padding: 1em 1em 0; 530 | } 531 | 532 | div.literal-block-wrapper div.highlight { 533 | margin: 0; 534 | } 535 | 536 | code.descname { 537 | background-color: transparent; 538 | font-weight: bold; 539 | font-size: 1.2em; 540 | } 541 | 542 | code.descclassname { 543 | background-color: transparent; 544 | } 545 | 546 | code.xref, a code { 547 | background-color: transparent; 548 | font-weight: bold; 549 | } 550 | 551 | h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { 552 | background-color: transparent; 553 | } 554 | 555 | .viewcode-link { 556 | float: right; 557 | } 558 | 559 | .viewcode-back { 560 | float: right; 561 | font-family: sans-serif; 562 | } 563 | 564 | div.viewcode-block:target { 565 | margin: -1px -10px; 566 | padding: 0 10px; 567 | } 568 | 569 | / -- math display ---------------------------------------------------------- / 570 | 571 | img.math { 572 | vertical-align: middle; 573 | } 574 | 575 | div.body div.math p { 576 | text-align: center; 577 | } 578 | 579 | span.eqno { 580 | float: right; 581 | } 582 | 583 | / -- printout stylesheet --------------------------------------------------- */ 584 | 585 | @media print { 586 | div.document, 587 | div.documentwrapper, 588 | div.bodywrapper { 589 | margin: 0 !important; 590 | width: 100%; 591 | } 592 | 593 | div.sphinxsidebar, 594 | div.related, 595 | div.footer, 596 | #top-link { 597 | display: none; 598 | } 599 | } --------------------------------------------------------------------------------

{{ .Title }}

Page not found

{{ .Title }}

Donate

Navigation

Related Topics

{{ .Site.Params.name }}