Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Customize CSS

Browse source
This commit is contained in:
Griatch 2020-06-15 20:08:00 +02:00
parent 31306f5b22
commit 667dd54846
4 changed files with 1107 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

46
docs/source/Contributing-Docs.md
View file

@ -9,7 +9,7 @@ Documentation for the Evennia MUD creation system.
The live documentation is (or will in the future be) available at The live documentation is (or will in the future be) available at
[https://evennia.github.io/evennia/latest](https://evennia.github.io/evennia/latest). [https://evennia.github.io/evennia/latest](https://evennia.github.io/evennia/latest).
# Editing the docs ## Editing the docs
The documentation source files are `*.md` (Markdown) files found in `evennia/docs/source/`. The documentation source files are `*.md` (Markdown) files found in `evennia/docs/source/`.
Markdown files are simple text files that can be edited with a normal text editor. They can also Markdown files are simple text files that can be edited with a normal text editor. They can also
@ -19,13 +19,13 @@ the [Markdown][commonmark] syntax. See [the syntax section below](#Editing-synta
> Note: Don't edit the files in `source/api/`. These are auto-generated and your changes > Note: Don't edit the files in `source/api/`. These are auto-generated and your changes
> will be lost. > will be lost.
## Contributing to docs ### Contributing to docs
Contributing to the docs is is like [contributing to the rest of Evennia][contributing]: Contributing to the docs is is like [contributing to the rest of Evennia][contributing]:
Check out the branch of Evennia you want to edit the documentation for. Create your Check out the branch of Evennia you want to edit the documentation for. Create your
own work-branch, make your changes to files in `evennia/docs/source/` and make a PR for it! own work-branch, make your changes to files in `evennia/docs/source/` and make a PR for it!
# Building the docs locally ## Building the docs locally
The sources in `evennia/docs/source/` are built into a pretty documentation using The sources in `evennia/docs/source/` are built into a pretty documentation using
the [Sphinx][sphinx] static generator system. To do so locally you need to either the [Sphinx][sphinx] static generator system. To do so locally you need to either
@ -37,7 +37,7 @@ You don't necessarily _have_ to build the docs locally to contribute. But
building them allows you to check for yourself that syntax is correct and that building them allows you to check for yourself that syntax is correct and that
your change comes out looking as you expected. your change comes out looking as you expected.
## Building only the main documentation ### Building only the main documentation
If you only want to build the main documentation pages (not the API auto-docs), If you only want to build the main documentation pages (not the API auto-docs),
you don't need to install Evennia itself, only the documentation resources. you don't need to install Evennia itself, only the documentation resources.
@ -65,7 +65,7 @@ All is done in your terminal/console.
the docs. Note that you will get errors if clicking a link to the auto-docs, because you didn't the docs. Note that you will get errors if clicking a link to the auto-docs, because you didn't
build them! build them!
## Building the main documentation and API docs ### Building the main documentation and API docs
The full documentation includes both the doc pages and the API documentation The full documentation includes both the doc pages and the API documentation
generated from the Evennia source. For this you must install Evennia and generated from the Evennia source. For this you must install Evennia and
@ -124,7 +124,7 @@ well. We won't touch that.
- Point your web browser to `file://<path-to-folder>/evennia/docs/build/html/index.html` to - Point your web browser to `file://<path-to-folder>/evennia/docs/build/html/index.html` to
view the full docs. view the full docs.
### Building with another gamedir #### Building with another gamedir
If you for some reason want to use another location of your `gamedir/`, or want it If you for some reason want to use another location of your `gamedir/`, or want it
named something else (maybe you already use the name 'gamedir' for your development ...), named something else (maybe you already use the name 'gamedir' for your development ...),
@ -135,7 +135,7 @@ of your alternative game dir. For example:
EVGAMEDIR=/my/path/to/mygamedir make local EVGAMEDIR=/my/path/to/mygamedir make local
``` ```
## Building for release ### Building for release
The full Evennia documentation contains docs from many Evennia The full Evennia documentation contains docs from many Evennia
versions, old and new. This is done by pulling documentation from Evennia's old release versions, old and new. This is done by pulling documentation from Evennia's old release
@ -155,7 +155,7 @@ This is as close to the 'real' version as you can get locally. The different ver
will be found under `evennia/docs/build`. During deploy a symlink `latest` will point will be found under `evennia/docs/build`. During deploy a symlink `latest` will point
to the latest version of the docs. to the latest version of the docs.
### Release #### Release
Releasing the official docs requires git-push access the the Evennia `gh-pages` branch Releasing the official docs requires git-push access the the Evennia `gh-pages` branch
on `github`. So there is no risk of you releasing your local changes accidentally. on `github`. So there is no risk of you releasing your local changes accidentally.
@ -181,14 +181,14 @@ available at https://evennia.github.io/evennia/latest/.
The format used for Evennia's docs is [Markdown][commonmark-help] (Commonmark). While markdown supports a The format used for Evennia's docs is [Markdown][commonmark-help] (Commonmark). While markdown supports a
few alternative forms for some of these, we try to stick to the below forms for consistency. few alternative forms for some of these, we try to stick to the below forms for consistency.
## Italic/Bold ### Italic/Bold
We generally use underscores for italics and double-asterisks for bold: We generally use underscores for italics and double-asterisks for bold:
- `_Italic text_` - _Italic text_ - `_Italic text_` - _Italic text_
- `**Bold Text**` - **Bold text** - `**Bold Text**` - **Bold text**
## Headings ### Headings
We use `#` to indicate sections/headings. The more `#` the more of a sub-heading it is (will get smaller We use `#` to indicate sections/headings. The more `#` the more of a sub-heading it is (will get smaller
and smaller font). and smaller font).
@ -197,14 +197,10 @@ and smaller font).
- `## SubHeading` - `## SubHeading`
- `## SubSubHeading` - `## SubSubHeading`
# Heading
## SubHeading
### SubSubHeading
> Don't reuse the same heading/subheading name over and over in the same document. While Markdown does not prevent > Don't reuse the same heading/subheading name over and over in the same document. While Markdown does not prevent
it, it makes it impossible to link to those duplicates properly (see next section). it, it makes it impossible to link to those duplicates properly (see next section).
## Lists ### Lists
One can create both bullet-point lists and numbered lists: One can create both bullet-point lists and numbered lists:
@ -228,7 +224,7 @@ One can create both bullet-point lists and numbered lists:
2. Numbered point two 2. Numbered point two
3. Numbered point three 3. Numbered point three
## Notes ### Notes
A note can be used to enphasise important things. It's added by starting one or more lines with `>`. A note can be used to enphasise important things. It's added by starting one or more lines with `>`.
@ -240,7 +236,7 @@ A note can be used to enphasise important things. It's added by starting one or
> Note: This is an important > Note: This is an important
> thing to remember. > thing to remember.
## Links ### Links
- `[linktext](url_or_ref)` - gives a clickable link [linktext][linkdemo]. - `[linktext](url_or_ref)` - gives a clickable link [linktext][linkdemo].
@ -271,11 +267,11 @@ This is a [clickable link][mylink]. This is [another link][1].
``` ```
### Special references #### Special references
The Evennia documentation supports some special reference shortcuts in links: The Evennia documentation supports some special reference shortcuts in links:
#### Github online repository ##### Github online repository
- `github:` - a shortcut for the full path to the Evennia repository on github. This will refer to - `github:` - a shortcut for the full path to the Evennia repository on github. This will refer to
the `master` branch by default: the `master` branch by default:
@ -287,7 +283,7 @@ The Evennia documentation supports some special reference shortcuts in links:
[link to objects.py](github:develop/evennia/objects/objects.py) [link to objects.py](github:develop/evennia/objects/objects.py)
#### API ##### API
- `api:` - references a path in the api documentation. This is specified as a Python-path: - `api:` - references a path in the api documentation. This is specified as a Python-path:
@ -298,7 +294,7 @@ The Evennia documentation supports some special reference shortcuts in links:
Since api-docs are generated alongside the documentation, this will always be the api docs for the Since api-docs are generated alongside the documentation, this will always be the api docs for the
current version/branch of the docs. current version/branch of the docs.
#### Bug reports/feature request ##### Bug reports/feature request
- `issue`, `bug-report`, `feature-request` - links to the same github issue select page. - `issue`, `bug-report`, `feature-request` - links to the same github issue select page.
@ -310,7 +306,7 @@ The Evennia documentation supports some special reference shortcuts in links:
> For some reason these particular shortcuts gives a warning during documentation compilation. This > For some reason these particular shortcuts gives a warning during documentation compilation. This
> can be ignored. > can be ignored.
## Verbatim text ### Verbatim text
It's common to want to mark something to be displayed verbatim - just as written - without any It's common to want to mark something to be displayed verbatim - just as written - without any
Markdown parsing. In running text, this is done using backticks (\`), like \`verbatim text\` becomes `verbatim text`. Markdown parsing. In running text, this is done using backticks (\`), like \`verbatim text\` becomes `verbatim text`.
@ -335,7 +331,7 @@ Everything within these backticks will be verbatim.
``` ```
```` ````
## Code blocks ### Code blocks
A special case is code examples - we want them to get code-highlighting for readability. This is done by using A special case is code examples - we want them to get code-highlighting for readability. This is done by using
the triple-backticks and specify which language we use: the triple-backticks and specify which language we use:
@ -356,7 +352,7 @@ def a_python_func(x):
``` ```
## ReST blocks ### ReST blocks
Markdown is easy to read and use. But while it does most of what we need, there are some things it's Markdown is easy to read and use. But while it does most of what we need, there are some things it's
not quite as expressive as it needs to be. For this we need to fall back to the [ReST][ReST] markup not quite as expressive as it needs to be. For this we need to fall back to the [ReST][ReST] markup
@ -567,7 +563,7 @@ for more flexibility. It also provides a link to the code block, identified by i
```` ````
```code-block:: python ```code-block:: python
:linenos: :linenos:
:emphasize-lines: 6-7,12 :emphasize-lines: 1-2,8
:caption: An example code block :caption: An example code block
:name: A full code block example :name: A full code block example

769
docs/source/_static/basic.css Normal file
View file

@ -0,0 +1,769 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}
a.brackets:after,
span.brackets > a:after {
content: "]";
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #787878;
padding: 5px 7px 7px 15px;
background-color: #f5fdff;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
th > p:first-child,
td > p:first-child {
margin-top: 0px;
}
th > p:last-child,
td > p:last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption {
padding: 0.3em;
}
div.figure p.caption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist td {
vertical-align: top;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
li > p:first-child {
margin-top: 0px;
}
li > p:last-child {
margin-bottom: 0px;
}
dl.footnote > dt,
dl.citation > dt {
float: left;
}
dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > p:first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0.5em;
content: ":";
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
-webkit-box-shadow: 0px 0px 0px #fff;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
/* padding: 0 0.5em 0 0.5em; */
}
div.code-block-caption {
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
div.code-block-caption + div > div.highlight > pre {
margin-top: 0;
}
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
padding: 1em 1em 0;
}
div.literal-block-wrapper div.highlight {
margin: 0;
}
code.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
code.descclassname {
background-color: transparent;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: relative;
left: 0px;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

300
docs/source/_static/nature.css Normal file
View file

@ -0,0 +1,300 @@
/*
* nature.css_t
* ~~~~~~~~~~~~
*
* Sphinx stylesheet -- nature theme.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: Arial, sans-serif;
font-size: 100%;
background-color: #fff;
color: #555;
margin: 0;
padding: 0;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
hr {
border: 1px solid #B1B4B6;
}
div.document {
background-color: #eee;
}
div.body {
background-color: #f1f1f1;
color: #3E4349;
padding: 0 30px 30px 30px;
font-size: 0.9em;
}
div.footer {
color: #555;
width: 100%;
padding: 13px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #444;
text-decoration: underline;
}
div.related {
background-color: #686868;
line-height: 32px;
color: #E0F8FF;
text-shadow: 0px 1px 0 #444;
font-size: 0.9em;
}
div.related a {
color: #E2F3CC;
}
blockquote {
font-style: italic;
background-color: #e1e8e2;
padding: 3px;
border: 1px solid #c7cdc8;
padding-left: 14px;
color: #797979;
div.sphinxsidebar {
font-size: 0.75em;
line-height: 1.5em;
}
div.sphinxsidebarwrapper{
padding: 20px 0;
}
div.sphinxsidebar h3,
div.sphinxsidebar h4 {
font-family: Arial, sans-serif;
color: #222;
font-size: 1.2em;
font-weight: normal;
margin: 0;
padding: 5px 10px;
background-color: #ddd;
}
div.sphinxsidebar h4{
font-size: 1.1em;
}
div.sphinxsidebar h3 a {
color: #444;
}
div.sphinxsidebar p {
color: #888;
padding: 5px 20px;
}
div.sphinxsidebar p.topless {
}
div.sphinxsidebar ul {
margin: 10px 20px;
padding: 0;
color: #000;
}
div.sphinxsidebar a {
color: #444;
}
div.sphinxsidebar input {
border: 1px solid #ccc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar .searchformwrapper {
margin-left: 20px;
margin-right: 20px;
}
input {
background-color: #efefef;
}
/* -- body styles ----------------------------------------------------------- */
a {
color: #005B81;
text-decoration: none;
}
a:hover {
color: #0EAEB6;
text-decoration: underline;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: Arial, sans-serif;
background-color: #f9f9f9;
font-weight: normal;
color: #212224;
margin: 30px 0px 10px 0px;
padding: 5px 0 5px 10px;
text-shadow: 0px 1px 0 white
border-bottom: 1px solid #d1d1d1;
border-left: 10px solid #c9daea;
border-bottom: 1px solid #c9daea;
}
div.body h1 {
margin-top: 20px solid #fff;
}
div.body h2 {
font-size: 150%;
}
div.body h3 {
font-size: 120%;
}
div.body h4 {
font-size: 110%;
}
div.body h5 {
font-size: 100%;
}
div.body h6 {
font-size: 100%;
}
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
line-height: 1.5em;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.highlight{
background-color: white;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
font-style: italic;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
font-style: italic;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
.admonition.important {
background-color: #fbf7c3;
border: 1px solid #c8c59b;
font-style: italic;
}
.admonition.note {
background-color: #e1e8e2;
}
.admonition.important {
background-color: #fbf7c3;
border: 1px solid #c8c59b;
font-style: italic;
}
pre {
padding: 10px;
background-color: #e3e3e3;
color: #222;
line-height: 1.2em;
border: 1px solid #C6C9CB;
font-size: 1.1em;
margin: 1.5em 0 1.5em 0;
-webkit-box-shadow: 1px 1px 1px #d8d8d8;
-moz-box-shadow: 1px 1px 1px #d8d8d8;
}
code {
background-color: #ecf0f3;
color: #6e0e0e;
/* padding: 1px 2px; */
font-size: 1.1em;
font-family: monospace;
font-weight: bold;
}
.viewcode-back {
font-family: Arial, sans-serif;
}
div.viewcode-block:target {
background-color: #f4debf;
border-top: 1px solid #ac9;
border-bottom: 1px solid #ac9;
}
div.code-block-caption {
background-color: #ddd;
color: #222;
border: 1px solid #C6C9CB;
}

19
docs/source/conf.py
View file

@ -62,8 +62,22 @@ smv_tag_whitelist = r"^$"
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# html_theme = "alabaster" # html_theme = "alabaster"
html_theme = "stanford_theme" # import stanford_theme
html_theme_path = [sphinx_theme.get_html_theme_path("stanford_theme")] # html_theme = "stanford_theme"
# html_theme_path = [stanford_theme.get_html_theme_path()]
# html_theme = "sunpy"
# import sunpy_sphinx_theme
# html_theme_path = sunpy_sphinx_theme.get_html_theme_path()
# html_theme = 'topos-theme'
# html_theme = 'sphinxdoc'
# html_theme = 'classic'
# html_theme = 'scrolls'
# html_theme = 'agogo'
# html_theme = "traditional"
html_theme = 'nature'
## html_theme = 'pyramid'
#html_theme = 'bizstyle'
# html_theme = 'epub'
# Custom extras for sidebar # Custom extras for sidebar
html_sidebars = { html_sidebars = {
@ -141,6 +155,7 @@ auto_toc_sections = ["Contents", "Toc", "Index"]
recommonmark_config = { recommonmark_config = {
"enable_auto_toc_tree": True, "enable_auto_toc_tree": True,
"url_resolver": url_resolver, "url_resolver": url_resolver,
"auto_toc_maxdepth": 1,
"auto_toc_tree_section": ["Contents", "Toc", "Index"], "auto_toc_tree_section": ["Contents", "Toc", "Index"],
"code_highlight_options": {"force": True, "linenos": True}, "code_highlight_options": {"force": True, "linenos": True},
} }