diff options
author | Joar Wandborg <git@wandborg.com> | 2012-04-01 01:21:20 +0200 |
---|---|---|
committer | Joar Wandborg <git@wandborg.com> | 2012-07-07 21:18:27 +0200 |
commit | f4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e (patch) | |
tree | 1332a4566dbbd53866c957517af686ee900a6c07 /api-docs/source/themes | |
parent | 8588505c6fc4d163f7434152310d509fb863d780 (diff) | |
download | mediagoblin-f4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e.tar.lz mediagoblin-f4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e.tar.xz mediagoblin-f4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e.zip |
Added API documentation
- Applied the MediaGoblin docs theme to the API docs
- Added api-docs/build to .gitignore
- Configured api-docs/source/conf.py
- Added /api-docs/source/mediagoblin* to .gitignore
- Added apidoc directive to api docs Makefile, will build the API docs
based on the source
Diffstat (limited to 'api-docs/source/themes')
-rw-r--r-- | api-docs/source/themes/mg/layout.html | 29 | ||||
-rw-r--r-- | api-docs/source/themes/mg/static/fonts/Lato-Bold.ttf | bin | 0 -> 93224 bytes | |||
-rw-r--r-- | api-docs/source/themes/mg/static/fonts/Lato-BoldItalic.ttf | bin | 0 -> 81936 bytes | |||
-rw-r--r-- | api-docs/source/themes/mg/static/fonts/Lato-Italic.ttf | bin | 0 -> 83680 bytes | |||
-rw-r--r-- | api-docs/source/themes/mg/static/fonts/Lato-Regular.ttf | bin | 0 -> 96044 bytes | |||
-rw-r--r-- | api-docs/source/themes/mg/static/fonts/OFL_1.1.txt | 97 | ||||
-rw-r--r-- | api-docs/source/themes/mg/static/logo_docs.png | bin | 0 -> 6626 bytes | |||
-rw-r--r-- | api-docs/source/themes/mg/static/mg.css | 161 | ||||
-rw-r--r-- | api-docs/source/themes/mg/theme.conf | 5 |
9 files changed, 292 insertions, 0 deletions
diff --git a/api-docs/source/themes/mg/layout.html b/api-docs/source/themes/mg/layout.html new file mode 100644 index 00000000..891ed64c --- /dev/null +++ b/api-docs/source/themes/mg/layout.html @@ -0,0 +1,29 @@ +{# + default/layout.html + ~~~~~~~~~~~~~~~~~~~ + + Sphinx layout template for the default theme. + + :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{% extends "basic/layout.html" %} + +{% if theme_collapsiblesidebar|tobool %} +{% set script_files = script_files + ['_static/sidebar.js'] %} +{% endif %} + +{%- block footer %} + <div class="footer"> + <div> + +MediaGoblin documentation released into the public domain via <a href="http://creativecommons.org/publicdomain/zero/1.0/">CC0</a>. + + {%- if last_updated %} + {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} + {%- endif %} + + {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %} + </div> + </div> +{%- endblock %} diff --git a/api-docs/source/themes/mg/static/fonts/Lato-Bold.ttf b/api-docs/source/themes/mg/static/fonts/Lato-Bold.ttf Binary files differnew file mode 100644 index 00000000..bc3529fc --- /dev/null +++ b/api-docs/source/themes/mg/static/fonts/Lato-Bold.ttf diff --git a/api-docs/source/themes/mg/static/fonts/Lato-BoldItalic.ttf b/api-docs/source/themes/mg/static/fonts/Lato-BoldItalic.ttf Binary files differnew file mode 100644 index 00000000..2cf5ae0d --- /dev/null +++ b/api-docs/source/themes/mg/static/fonts/Lato-BoldItalic.ttf diff --git a/api-docs/source/themes/mg/static/fonts/Lato-Italic.ttf b/api-docs/source/themes/mg/static/fonts/Lato-Italic.ttf Binary files differnew file mode 100644 index 00000000..11ca3eb6 --- /dev/null +++ b/api-docs/source/themes/mg/static/fonts/Lato-Italic.ttf diff --git a/api-docs/source/themes/mg/static/fonts/Lato-Regular.ttf b/api-docs/source/themes/mg/static/fonts/Lato-Regular.ttf Binary files differnew file mode 100644 index 00000000..26ce1002 --- /dev/null +++ b/api-docs/source/themes/mg/static/fonts/Lato-Regular.ttf diff --git a/api-docs/source/themes/mg/static/fonts/OFL_1.1.txt b/api-docs/source/themes/mg/static/fonts/OFL_1.1.txt new file mode 100644 index 00000000..f1a20ac1 --- /dev/null +++ b/api-docs/source/themes/mg/static/fonts/OFL_1.1.txt @@ -0,0 +1,97 @@ +Copyright (c) <dates>, <Copyright Holder> (<URL|email>),
+with Reserved Font Name <Reserved Font Name>.
+Copyright (c) <dates>, <additional Copyright Holder> (<URL|email>),
+with Reserved Font Name <additional Reserved Font Name>.
+Copyright (c) <dates>, <additional Copyright Holder> (<URL|email>).
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/api-docs/source/themes/mg/static/logo_docs.png b/api-docs/source/themes/mg/static/logo_docs.png Binary files differnew file mode 100644 index 00000000..99f04cc7 --- /dev/null +++ b/api-docs/source/themes/mg/static/logo_docs.png diff --git a/api-docs/source/themes/mg/static/mg.css b/api-docs/source/themes/mg/static/mg.css new file mode 100644 index 00000000..96344df4 --- /dev/null +++ b/api-docs/source/themes/mg/static/mg.css @@ -0,0 +1,161 @@ +/* + +MediaGoblin theme - MediaGoblin-style Sphinx documentation theme + +Written in 2012 by Jef van Schendel <mail@jefvanschendel.nl> + +To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty. + +You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. + +*/ + +@import url("basic.css"); + +/* text fonts and styles */ + +@font-face { + font-family: 'Lato'; + font-style: normal; + font-weight: 700; + src: local('Lato Bold'), local('Lato-Bold'), url('fonts/Lato-Bold.ttf') format('truetype'); +} +@font-face { + font-family: 'Lato'; + font-style: italic; + font-weight: 400; + src: local('Lato Italic'), local('Lato-Italic'), url('fonts/Lato-Italic.ttf') format('truetype'); +} +@font-face { + font-family: 'Lato'; + font-style: italic; + font-weight: 700; + src: local('Lato Bold Italic'), local('Lato-BoldItalic'), url('fonts/Lato-BoldItalic.ttf') format('truetype'); +} +@font-face { + font-family: 'Lato'; + font-style: normal; + font-weight: 400; + src: local('Lato Regular'), local('Lato-Regular'), url('fonts/Lato-Regular.ttf') format('truetype'); +} + +body { + font: 16px 'Lato',Helvetica,Arial,sans-serif; + background-color: #FCFCFC; + color: #3C3C3C; + margin: 0; + padding: 0; +} + +h1, h2, h3, h4, h5, h6 { + border-bottom: 1px solid #CCCCCC; + background: none; + color: black; + font-weight: bold; + padding-bottom: 0.17em; + padding-top: 0.5em; +} + +h1 { + font-size: 1.875em; +} + +h2 { + font-size: 1.375em; +} + +h3, h4, h5, h6 { + font-size: 1.125em; +} + +p { + font-weight: normal; + margin: 0.4em 0 0.5em; +} + +a { + color: #499776; +} + +a:visited { + color: #2A5744; +} + +a:active { + color: #65D1A3; +} + +h1 a, h2 a, h3 a, h4 a, h5 a, h6 a { + text-decoration: none; +} + +div.topic, pre { + background-color: #F1F1F1; + border: 1px dashed #ccc; + color: black; + line-height: 1.1em; + padding: 1em; +} + +code, tt { + font: 14px monospace,"Courier New"; + background-color: #FFFFDD; + border: thin solid #bbb; + padding-left: 5px; + padding-right: 5px; +} + +pre { + font: 14px monospace,"Courier New"; +} + +div.related a, div.related a:visited, div.related a:active { + color: #86D4B1; +} + +/* layout */ + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 270px; +} + +div.body { + padding: 0 20px 30px 20px; +} + +div.footer { + width: 100%; + padding: 9px 0 9px 0; + text-align: center; + font-size: 75%; +} + +div.sphinxsidebar { + width: 240px; +} + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 30px; +} + +div.sphinxsidebar ul { + margin: 10px 10px 10px 0; + padding: 0; +} + +div.related { + line-height: 30px; + font-size: 90%; + width: 100%; + background-color: #161616; + color: #C3C3C3; +} + +p.logo { + margin-top: 30px; +} diff --git a/api-docs/source/themes/mg/theme.conf b/api-docs/source/themes/mg/theme.conf new file mode 100644 index 00000000..dd58038a --- /dev/null +++ b/api-docs/source/themes/mg/theme.conf @@ -0,0 +1,5 @@ +[theme] +inherit = basic +stylesheet = mg.css +pygments_style = sphinx + |