From c25769c81c6dedfa67c3d6656fb174560e76486d Mon Sep 17 00:00:00 2001 From: Victor Toso Date: Tue, 13 Oct 2015 10:18:29 +0200 Subject: documentation: including old documentation The goal for Documentation interface is to have all documentation that we have spread out. But fist, we must keep all content we have to be sure nothing is lost by mistake in this transition process. --- content/pages/documentation.rst | 88 +++++++++++++++++++++ content/static/docs/Apache_License_2.0.txt | 13 +++ content/static/docs/BSD_style.txt | 30 +++++++ content/static/docs/GPL.txt | 17 ++++ content/static/docs/LGPL.txt | 18 +++++ .../docs/UsbDk_Software_Development_Manual.pdf | Bin 0 -> 364768 bytes content/static/docs/UsbDk_at_a_Glance.pdf | Bin 0 -> 7855450 bytes content/static/docs/spice_for_newbies.pdf | Bin 0 -> 188793 bytes content/static/docs/spice_protocol.pdf | Bin 0 -> 186494 bytes content/static/docs/spice_redhat_summit_2009.odp | Bin 0 -> 389880 bytes content/static/docs/spice_redhat_summit_2009.pdf | Bin 0 -> 424109 bytes content/static/docs/spice_style.pdf | Bin 0 -> 169475 bytes content/static/docs/spice_user_manual.pdf | Bin 0 -> 159282 bytes content/static/docs/vd_interfaces.pdf | Bin 0 -> 117684 bytes pelicanconf.py | 4 + 15 files changed, 170 insertions(+) create mode 100644 content/pages/documentation.rst create mode 100644 content/static/docs/Apache_License_2.0.txt create mode 100644 content/static/docs/BSD_style.txt create mode 100644 content/static/docs/GPL.txt create mode 100644 content/static/docs/LGPL.txt create mode 100644 content/static/docs/UsbDk_Software_Development_Manual.pdf create mode 100644 content/static/docs/UsbDk_at_a_Glance.pdf create mode 100644 content/static/docs/spice_for_newbies.pdf create mode 100644 content/static/docs/spice_protocol.pdf create mode 100644 content/static/docs/spice_redhat_summit_2009.odp create mode 100644 content/static/docs/spice_redhat_summit_2009.pdf create mode 100644 content/static/docs/spice_style.pdf create mode 100644 content/static/docs/spice_user_manual.pdf create mode 100644 content/static/docs/vd_interfaces.pdf diff --git a/content/pages/documentation.rst b/content/pages/documentation.rst new file mode 100644 index 0000000..a4fc5d1 --- /dev/null +++ b/content/pages/documentation.rst @@ -0,0 +1,88 @@ +Documentation +############################################################################### + +:slug: documentation +:part-of: documentation +:modified: 2015-10-13 09:00 + +.. _Apache 2.0: {filename}/static/docs/Apache_License_2.0.txt +.. _BSD: {filename}/static/docs/BSD_style.txt +.. _GPL: {filename}/static/docs/GPL.txt +.. _LGPL: {filename}/static/docs/LGPL.txt +.. _spice for newbies: {filename}/static/docs/spice_for_newbies.pdf +.. _spice protocol: {filename}/static/docs/spice_protocol.pdf +.. _ODP version: {filename}/static/docs/spice_redhat_summit_2009.odp +.. _PDF version: {filename}/static/docs/spice_redhat_summit_2009.pdf +.. _spice style: {filename}/static/docs/spice_style.pdf +.. _spice user manual: {filename}/static/docs/spice_user_manual.pdf +.. _UsbDk Presentation: {filename}/static/docs/UsbDk_at_a_Glance.pdf +.. _UsbDk Manual: {filename}/static/docs/UsbDk_Software_Development_Manual.pdf +.. _VD Interfaces: {filename}/static/docs/vd_interfaces.pdf + +Copyright license templates that must be appended to newlyadded files - GPL_, +LGPL_, `Apache 2.0`_ and BSD_ + +**Spice Reference Manual** + +This describes the various features provided by SPICE, and how to make use of +them when using QEMU/libvirt/virt-manager. + +**spice-gtk API documentation** + +This describes spice-gtk C API. + +Important: The pdf docs were written for spice 0.4 and is thus not wholly up to +date. + +**Spice For Newbies** + +Contains basic information about Spice's architecture, components, and features +|br| +Download `spice for newbies`_ + + +**Spice User Manual** + +Includes all of the information you need to use Spice, such as downloading, +building, installing, and executing |br| +Download `spice user manual`_ + +**SPICE Protocol** + +Outlines the complete definition of the SPICE remote computing protocol |br| +Download `spice protocol`_ + +Outlines the complete definition of the SPICE client <-> agent protocol |br| + +.. + TODO + `Go to AgentProtocol wiki page`_ + +**VD Interfaces** + +Includes the VD Interface specifications |br| +Download `VD interfaces`_ + +**Spice style** + +Defines Spice project's coding style and coding conventions |br| +Download `spice style`_ + +**Red Hat Summit 2009** + +Spice session presentation at Red Hat Summit 2009 |br| +Download `ODP version`_ or `PDF version`_ + +**UsbDk** + +Download `UsbDk Presentation`_ |br| +Download `UsbDk Manual`_ + +**License** + +Copyright license templates that must be appended to newlyadded files - GPL_, +LGPL_, `Apache 2.0`_ and BSD_ + +.. |br| raw:: html + +
diff --git a/content/static/docs/Apache_License_2.0.txt b/content/static/docs/Apache_License_2.0.txt new file mode 100644 index 0000000..004c62e --- /dev/null +++ b/content/static/docs/Apache_License_2.0.txt @@ -0,0 +1,13 @@ +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/content/static/docs/BSD_style.txt b/content/static/docs/BSD_style.txt new file mode 100644 index 0000000..43efb66 --- /dev/null +++ b/content/static/docs/BSD_style.txt @@ -0,0 +1,30 @@ +/* + Copyright (C) + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS + IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + diff --git a/content/static/docs/GPL.txt b/content/static/docs/GPL.txt new file mode 100644 index 0000000..40c19e1 --- /dev/null +++ b/content/static/docs/GPL.txt @@ -0,0 +1,17 @@ +/* + Copyright (C) + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of + the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + diff --git a/content/static/docs/LGPL.txt b/content/static/docs/LGPL.txt new file mode 100644 index 0000000..6875176 --- /dev/null +++ b/content/static/docs/LGPL.txt @@ -0,0 +1,18 @@ +/* + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ diff --git a/content/static/docs/UsbDk_Software_Development_Manual.pdf b/content/static/docs/UsbDk_Software_Development_Manual.pdf new file mode 100644 index 0000000..80b9199 Binary files /dev/null and b/content/static/docs/UsbDk_Software_Development_Manual.pdf differ diff --git a/content/static/docs/UsbDk_at_a_Glance.pdf b/content/static/docs/UsbDk_at_a_Glance.pdf new file mode 100644 index 0000000..d8ac733 Binary files /dev/null and b/content/static/docs/UsbDk_at_a_Glance.pdf differ diff --git a/content/static/docs/spice_for_newbies.pdf b/content/static/docs/spice_for_newbies.pdf new file mode 100644 index 0000000..f61ce9c Binary files /dev/null and b/content/static/docs/spice_for_newbies.pdf differ diff --git a/content/static/docs/spice_protocol.pdf b/content/static/docs/spice_protocol.pdf new file mode 100644 index 0000000..160224d Binary files /dev/null and b/content/static/docs/spice_protocol.pdf differ diff --git a/content/static/docs/spice_redhat_summit_2009.odp b/content/static/docs/spice_redhat_summit_2009.odp new file mode 100644 index 0000000..66336bd Binary files /dev/null and b/content/static/docs/spice_redhat_summit_2009.odp differ diff --git a/content/static/docs/spice_redhat_summit_2009.pdf b/content/static/docs/spice_redhat_summit_2009.pdf new file mode 100644 index 0000000..7b5f284 Binary files /dev/null and b/content/static/docs/spice_redhat_summit_2009.pdf differ diff --git a/content/static/docs/spice_style.pdf b/content/static/docs/spice_style.pdf new file mode 100644 index 0000000..a00ea51 Binary files /dev/null and b/content/static/docs/spice_style.pdf differ diff --git a/content/static/docs/spice_user_manual.pdf b/content/static/docs/spice_user_manual.pdf new file mode 100644 index 0000000..2603ec6 Binary files /dev/null and b/content/static/docs/spice_user_manual.pdf differ diff --git a/content/static/docs/vd_interfaces.pdf b/content/static/docs/vd_interfaces.pdf new file mode 100644 index 0000000..a4b7a5b Binary files /dev/null and b/content/static/docs/vd_interfaces.pdf differ diff --git a/pelicanconf.py b/pelicanconf.py index 729d1a1..8e9326a 100644 --- a/pelicanconf.py +++ b/pelicanconf.py @@ -12,6 +12,10 @@ TIMEZONE = 'Europe/Paris' DEFAULT_LANG = u'en' +# Static content that we reference in our site goes into folders appointed +# by this path +STATIC_PATHS = ['static/docs'] + # Feed generation is usually not desired when developing FEED_ALL_ATOM = None CATEGORY_FEED_ATOM = None -- cgit v1.2.3