From 4499d8353b8476fafa3b14f81b2551f2ca5e6990 Mon Sep 17 00:00:00 2001
From: Clement Verna <cverna@tutanota.com>
Date: Dec 20 2018 08:53:04 +0000
Subject: Add an user guide documentation


Signed-off-by: Clement Verna <cverna@tutanota.com>

---

diff --git a/.gitignore b/.gitignore
index 4465ddc..d3ecdfb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,3 +16,6 @@ build
 .vscode/
 .tox/
 .venv/
+_build
+_static
+_templates
diff --git a/README.md b/README.md
index c816095..aa7a4c4 100644
--- a/README.md
+++ b/README.md
@@ -2,24 +2,10 @@
 
 A Python library for Pagure APIs. Pagure is a light-weight git-centered forge based on pygit2, created by Pierre-Yves Chibon.
 
-## Installation
----
-
-Use pip to install.
-
-### Linux
----
-
-```
-pip3 install libpagure
-```
 
-### OS X
----
+## User Guide
 
-```
-python3 -m pip install libpagure
-```
+A more detail user guide is available [here](https://docs.pagure.org/libpagure/)
 
 ## Usage
 ---
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..298ea9e
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..4d9370f
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'libpagure'
+copyright = '2018, Lei Yang'
+author = 'Lei Yang'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.10'
+
+
+# -- 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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 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 = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'libpaguredoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'libpagure.tex', 'libpagure Documentation',
+     'Lei Yang', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'libpagure', 'libpagure Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'libpagure', 'libpagure Documentation',
+     author, 'libpagure', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..94a1102
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,27 @@
+.. libpagure documentation master file, created by
+   sphinx-quickstart on Thu Dec 20 09:12:39 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to libpagure's documentation!
+=====================================
+
+This package provides an API wrapper to interact with `pagure`_.
+
+.. _`pagure`: https://pagure.io/pagure
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   userguide
+
+This package is licensed under the GNU General Public License v2 (GPLv2).
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/userguide.rst b/docs/userguide.rst
new file mode 100644
index 0000000..cd5d7de
--- /dev/null
+++ b/docs/userguide.rst
@@ -0,0 +1,46 @@
+User Guide
+==========
+
+Installation
+------------
+
+libpagure is available on PyPI, you can install it using pip::
+
+$ python3 -m pip install libpagure
+
+
+Connecting
+----------
+
+Import the main ``Pagure`` class and instanciate it, passing a custom URL if
+necessary:
+
+>>> from libpagure import Pagure
+>>> pg = Pagure(instance_url="https://src.fedoraproject.org/")
+
+.. note::
+
+    By default the Pagure class will connect to https://pagure.io.
+
+
+Authentication
+--------------
+
+In order to use API endpoints that require authentication, you can provide
+and API token to the ``Pagure`` class:
+
+>>> from libpagure import Pagure
+>>> pg = Pagure(pagure_token="MYSECRETAPITOKEN")
+
+
+User Information
+----------------
+
+>>> from libpagure import Pagure
+>>> pg = Pagure()
+>>> user = pg.user("cverna")
+>>> user.fullname
+>>> "Clement Verna"
+>>> user.name
+>>> "cverna"
+

