[Pkg-owncloud-commits] [owncloud-doc] 04/09: move doc index pages to their own repo
David Prévot
taffit at moszumanska.debian.org
Sat Sep 12 16:40:36 UTC 2015
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch master
in repository owncloud-doc.
commit cd28a4cd28560170fb6df754598736fbd9aa6311
Author: Carla Schroder <carla at owncloud.com>
Date: Fri Sep 11 10:03:33 2015 -0700
move doc index pages to their own repo
---
index/Makefile | 173 ---------------------------------------------
index/conf.py | 169 -------------------------------------------
index/howto_contribute.rst | 63 -----------------
index/index.rst | 168 -------------------------------------------
4 files changed, 573 deletions(-)
diff --git a/index/Makefile b/index/Makefile
deleted file mode 100644
index 74c47b1..0000000
--- a/index/Makefile
+++ /dev/null
@@ -1,173 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " pdf to make PDF files"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " texinfo to make Texinfo files"
- @echo " info to make Texinfo files and run them through makeinfo"
- @echo " gettext to make PO message catalogs"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- -rm -rf $(BUILDDIR)/*
-
-html: html-org
-
-html-all: html-release html-org html-com
-
-html-release:
- $(SPHINXBUILD) -b html -D html_theme='owncloud_release' $(ALLSPHINXOPTS) $(BUILDDIR)/html/release
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/release."
-
-html-org:
- $(SPHINXBUILD) -b html -D html_theme='owncloud_org' $(ALLSPHINXOPTS) $(BUILDDIR)/html/org
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/org."
-
-html-com:
- $(SPHINXBUILD) -b html -D html_theme='owncloud_com' $(ALLSPHINXOPTS) $(BUILDDIR)/html/com
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/com."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OwncloudDocumentation.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OwncloudDocumentation.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/OwncloudDocumentation"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OwncloudDocumentation"
- @echo "# devhelp"
-
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-pdf:
- $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
- @echo
- @echo "build finished. the text files are in $(BUILDDIR)/pdf."
-
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "build finished. the text files are in $(BUILDDIR)/text."
-
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo
- @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
- @echo "Run \`make' in that directory to run these through makeinfo" \
- "(use \`make info' here to do that automatically)."
-
-info:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo "Running Texinfo files through makeinfo..."
- make -C $(BUILDDIR)/texinfo info
- @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/index/conf.py b/index/conf.py
deleted file mode 100644
index 76b8382..0000000
--- a/index/conf.py
+++ /dev/null
@@ -1,169 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# ownCloud Documentation documentation build configuration file, created by
-# sphinx-quickstart on Mon Oct 22 23:16:40 2012.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['../_shared_assets/templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'ownCloud'
-copyright = u'2011-2015, The ownCloud developers'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = ''
-# The full version, including alpha/beta/rc tags.
-release = ''
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['../_shared_assets/themes']
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'owncloud_org'
-html_theme_options = {
-# "rightsidebar": "true",
- "show_search": False,
-
-
-}
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['../_shared_assets/static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-html_show_sphinx = False
-
-#html_hide_search = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
diff --git a/index/howto_contribute.rst b/index/howto_contribute.rst
deleted file mode 100644
index 460b793..0000000
--- a/index/howto_contribute.rst
+++ /dev/null
@@ -1,63 +0,0 @@
-===============================================
-How to Contribute to the ownCloud Documentation
-===============================================
-
-You are encouraged to contribute to the ownCloud documentation by reporting
-errors, adding new material, and writing tips and tricks. You must have a
-`Github <https://github.com/>`_ account.
-
-Sharing tips and tricks is the easiest way to contribute, because these go in
-the `ownCloud Documentation Wiki <https://github.com/owncloud/documentation/wiki>`_. You can create and edit docs directly in the
-Wiki. The subject matter is wide open: admin, user, mobile apps, LAMP stack,
-development hints, installing ownCloud on diverse hardware such as Raspberry
-Pi or giant clusters-- anything that is correct and useful.
-
-If you wish to contribute to the official Admin, User, or Desktop Client and
-Mobile Apps manuals, that is a more complex process because you must
-fork or branch the official repos, write your material, and create a pull
-request. The manuals are written using Sphinx and RST markup.
-
-* The Admin and User manuals are in the
- `owncloud/documentation <https://github.com/owncloud/documentation>`_
- repository on Github. Read the README.rst on the front page of the repo for
- instructions on setting up your build enviroment.
-
-* The documentation for the desktop sync client is in the ``doc`` directory of the
- `Desktop client repo <https://github.com/owncloud/client>`_. See the
- README.md for instructions.
-
-* The documentation of the Android app is in the ``user_manual`` directory of
- the `Android App repo <https://github.com/owncloud/android>`_. See the
- README.md for instructions.
-
-* The documentation of the iOS app is in the ``user_manual`` directory of
- the `iOS App repo <https://github.com/owncloud/ios>`_. See the README.md for
- instructions.
-
-Reporting Documentation Errors
-------------------------------
-
-If you find errors or omissions in the Admin, User, or Desktop Client and
-Mobile Apps manuals, we encourage you to report them. (The Developer manual has
-its own system and requirements; please consult the Developer manual for
-details.)
-
-Please follow this template when reporting documentation errors:
-
-* First search the appropriate Github repository to see if your issue has
- already been reported
-* If it has not, open an Issue in the appropriate Github repository
-* Provide the URL to the manual page and section. There are multiple release
- versions of most of the manuals, so please mention exactly which one you are
- reporting, and if it is the HTML or PDF version
-* Quote the specific error
-* Provide the correct solution, if you know it, and links to supporting
- references. If you don't know the answer that is OK.
-* Provide screenshots if they add useful information
-* Provide your Web browser version and operating system & version
-
-Reporting Documentation Suggestions
------------------------------------
-
-If you don't have a specific problem or contribution, but wish to offer a
-suggestion, open an Issue in the appropriate repository.
diff --git a/index/index.rst b/index/index.rst
deleted file mode 100644
index c335de9..0000000
--- a/index/index.rst
+++ /dev/null
@@ -1,168 +0,0 @@
-===============================
-ownCloud Documentation Overview
-===============================
-
-----------------
-Getting ownCloud
-----------------
-
-You can download and install ownCloud on your own Linux server, use the Web
-Installer to install it on shared Web hosting, try some prefab cloud images,
-or sign up for hosted ownCloud services. See the `Get Started
-<https://owncloud.org/install/>`_ page for more information.
-
-.. rework this section
-.. -----------------------------
-.. Additional ownCloud Resources
-.. -----------------------------
-
-.. * `Howto, demo, news, and Webinar videos
-.. <https://doc.owncloud.org/server/8.0/admin_manual/videos/index.html>`_
-.. * `What's New in ownCloud 8
-.. <https://owncloud.org/eight>`_ Video introduction to ownCloud 8.
-.. * `Where to get help
-.. <https://owncloud.org/support/>`_ when the documentation is not enough.
-
-------------------------------------------------
-Reporting Documentation Bugs & How to Contribute
-------------------------------------------------
-
-If you find an error or omission in any of the manuals, we welcome your bug
-reports and contributions. Please see :doc:`howto_contribute` for instructions.
-
-------------
-ownCloud 8.2
-------------
-
-This documents the *development* version of ownCloud.
-
-* `User Manual <https://doc.owncloud.org/server/8.2/user_manual/>`_ (`Download
- PDF <https://doc.owncloud.org/server/8.2/ownCloudUserManual.pdf>`_)
-* `Administration Manual <https://doc.owncloud.org/server/8.2/admin_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/8.2/ownCloudServerAdminManual.pdf>`_)
-* `Developer Manual <https://doc.owncloud.org/server/8.2/developer_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/8.2/ownCloudDeveloperManual.pdf>`_)
-
-------------
-ownCloud 8.1
-------------
-
-This documents the *latest production* version of ownCloud.
-
-* `User Manual <https://doc.owncloud.org/server/8.1/user_manual/>`_ (`Download
- PDF <https://doc.owncloud.org/server/8.1/ownCloudUserManual.pdf>`_)
-* `Administration Manual <https://doc.owncloud.org/server/8.1/admin_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/8.1/ownCloudServerAdminManual.pdf>`_)
-* `Developer Manual <https://doc.owncloud.org/server/8.1/developer_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/8.1/ownCloudDeveloperManual.pdf>`_)
-
-------------
-ownCloud 8.0
-------------
-
-This documents the *previous production* version of ownCloud, Server and
-Enterprise Subscription.
-
-* `User Manual <https://doc.owncloud.org/server/8.0/user_manual/>`_ (`Download
- PDF <https://doc.owncloud.org/server/8.0/ownCloudUserManual.pdf>`_)
-* `Administration Manual <https://doc.owncloud.org/server/8.0/admin_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/8.0/ownCloudServerAdminManual.pdf>`_)
-* `Developer Manual <https://doc.owncloud.org/server/8.0/developer_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/8.0/ownCloudDeveloperManual.pdf>`_)
-
-------------------------------
-ownCloud Community Edition 7.0
-------------------------------
-
-This documents the ownCloud 7.0 release, suitable for production use.
-
-* `User Manual <https://doc.owncloud.org/server/7.0/user_manual/>`_ (`Download
- PDF <https://doc.owncloud.org/server/7.0/ownCloudUserManual.pdf>`_)
-* `Administrator Manual <https://doc.owncloud.org/server/7.0/admin_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/7.0/ownCloudAdminManual.pdf>`_)
-* `Developer Manual <https://doc.owncloud.org/server/7.0/developer_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/7.0/ownCloudDeveloperManual.pdf>`_)
-
-==============================
-Desktop Client and Mobile Apps
-==============================
-
----------------------------
-ownCloud Desktop Client 2.0
----------------------------
-
-The *latest* ownCloud desktop sync client release, suitable for production use.
-
-* `ownCloud Desktop Client Manual <https://doc.owncloud.org/desktop/2.0/>`_
- (`Download PDF
- <https://doc.owncloud.org/desktop/2.0/ownCloudClientManual.pdf>`_)
-
----------------------------
-ownCloud Desktop Client 1.8
----------------------------
-
-The *previous* ownCloud desktop sync client release. Users are encouraged to upgrade.
-
-* `ownCloud Desktop Client Manual <https://doc.owncloud.org/desktop/1.8/>`_
- (`Download PDF
- <https://doc.owncloud.org/desktop/1.8/ownCloudClientManual.pdf>`_)
-
---------------------
-ownCloud Android App
---------------------
-
-* `ownCloud Android App Manual <https://doc.owncloud.org/android/>`_ (`Download
- PDF <https://doc.owncloud.org/android/ownCloudAndroidAppManual.pdf>`_)
-
-----------------
-ownCloud iOS App
-----------------
-
-* `ownCloud iOS App Manual <https://doc.owncloud.org/ios/>`_ (`Download PDF
- <https://doc.owncloud.org/ios/ownCloudiOSAppManual.pdf>`_)
-
-=======================
-Older ownCloud Releases
-=======================
-
-------------------------------
-ownCloud Community Edition 6.0
-------------------------------
-
-This documents the *older* ownCloud release. ownCloud 6 receives security
-fixes, and users are encouraged to upgrade to the latest production release.
-
-* `User Manual <https://doc.owncloud.org/server/6.0/user_manual/>`_ (`Download
- PDF <https://doc.owncloud.org/server/6.0/ownCloudUserManual.pdf>`_)
-* `Administrator Manual <https://doc.owncloud.org/server/6.0/admin_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/6.0/ownCloudAdminManual.pdf>`_)
-
-------------------------------
-ownCloud Community Edition 5.0
-------------------------------
-
-This documents the *deprecated* ownCloud release. Users are encouraged to
-upgrade to the latest production release.
-
-* `User Manual <https://doc.owncloud.org/server/5.0/user_manual/>`_ (`Download
- PDF <https://doc.owncloud.org/server/6.0/ownCloudUserManual.pdf>`_)
-* `Administrator Manual <https://doc.owncloud.org/server/5.0/admin_manual/>`_
- (`Download PDF
- <https://doc.owncloud.org/server/5.0/ownCloudAdminManual.pdf>`_)
-
--------------------------------------
-Previous ownCloud Enterprise Editions
--------------------------------------
-
-You'll find all admin and user manuals for older ownCloud Enterprise editions
-(7.0, 6.0, and 5.0) at the ownCloud Documentation Overview on
-`doc.owncloud.com <http://doc.owncloud.com/>`_.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git
More information about the Pkg-owncloud-commits
mailing list