Merge pull request #40 from jespino/fix-docs

Roland Hedberg · Roland Hedberg · commit a326007b1588 · 2015-09-03T10:33:55.000+02:00
Fix documentation merge conflicts
diff --git a/doc/Makefile b/doc/Makefile
@@ -7,14 +7,11 @@ SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
 
-<<<<<<< HEAD
-=======
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
 endif
 
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
@@ -37,30 +34,20 @@ help:
 	@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"
-<<<<<<< HEAD
-=======
 	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 	@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"
-<<<<<<< HEAD
-=======
 	@echo "  xml        to make Docutils-native XML files"
 	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
 clean:
-<<<<<<< HEAD
 	-rm -rf $(BUILDDIR)/*
-=======
-	rm -rf $(BUILDDIR)/*
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -98,28 +85,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-<<<<<<< HEAD
 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyjwkest.qhcp"
 	@echo "To view the help file:"
 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyjwkest.qhc"
-=======
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyoidc.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyoidc.qhc"
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-<<<<<<< HEAD
 	@echo "# mkdir -p $$HOME/.local/share/devhelp/pyjwkest"
 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyjwkest"
-=======
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/pyoidc"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyoidc"
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 	@echo "# devhelp"
 
 epub:
@@ -140,15 +116,12 @@ latexpdf:
 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
-<<<<<<< HEAD
-=======
 latexpdfja:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 	@echo "Running LaTeX files through platex and dvipdfmx..."
 	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 text:
 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 	@echo
@@ -192,8 +165,6 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
-<<<<<<< HEAD
-=======
 
 xml:
 	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@@ -204,4 +175,3 @@ pseudoxml:
 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 	@echo
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
diff --git a/doc/howto/index.rst b/doc/howto/index.rst
@@ -1,12 +1,12 @@
 .. _howto:
 
-How to use pyOIDC
-=================
+How to use pyJWKEST
+===================
 
 :Release: |release|
 :Date: |today|
 
-Before you can use pyOIDC, you'll need to get it installed.
+Before you can use pyJWKEST, you'll need to get it installed.
 If you have not done it yet, read the :ref:`install`
 
 Once you have it installed you can try to run the examples.
diff --git a/doc/install.rst b/doc/install.rst
@@ -3,52 +3,25 @@
 Quick install guide
 ###################
 
-<<<<<<< HEAD
-Before you can use pyOIDC, you'll need to get it installed. This guide
+Before you can use pyJWKEST, you'll need to get it installed. This guide
 will guide you to a simple, minimal installation.
 
 Install pyJWKEST
 ================
-=======
-Before you can use PyOIDC, you'll need to get it installed. This guide
-will guide you to a simple, minimal installation.
-
-Install PyOIDC
-==============
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 
 For all this to work you need to have Python installed.
 The development has been done using 2.7.
 There will shortly be a 3.4 version.
 
 Prerequisites
-<<<<<<< HEAD
 =============
 
 For installing pyJWKEST you will need
 
 * pycrypto
-=======
-==============
-
-For installing pyOIDC you will need
-
-* requests
-* pycrypto
-* pyjwkest
-* pysaml2
-* dirg-util
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
-
-To build the documentation you will need
-
-* alabaster
 
 and for running the examples:
 
-<<<<<<< HEAD
-* pycrypto
-=======
 * mako
 * cherrypy
 * beaker
@@ -57,26 +30,15 @@ and for running the examples:
 * importlib
 * M2Crypto
 * swig
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 
 For running the tests you will additionally need to install:
 
 * pytest
 
-<<<<<<< HEAD
 Debian/Mac
 ==========
 
 If you don't want to install pyjwkest and all it's dependencies manually you can use yais
-=======
-If you wish your LDAP tests to pass, ensure you have installed the following package as well:
-
-* python-ldap (not supported in windows)
-
-Debian/Mac
-==============
-If you don't want to install pyoidc and all it's dependencies manually you can use yais
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 
 Open a terminal and enter::
 
@@ -86,11 +48,7 @@ Open a terminal and enter::
     cd [your path]/yais/script
     ./yais.sh
 
-<<<<<<< HEAD
-On the question “Do you want to install pyjwkest (Y/n):”, type Y. Everything else should be ignored, by typing n. The script will install pyoidc and all it's dependencies.
-=======
-On the question “Do you want to install pyoidc (Y/n):”, type Y. Everything else should be ignored, by typing n. The script will install pyoidc and all it's dependencies.
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
+On the question “Do you want to install pyjwkest (Y/n):”, type Y. Everything else should be ignored, by typing n. The script will install pyjwkest and all it's dependencies.
 
 Quick build instructions
 ------------------------
@@ -113,35 +71,3 @@ The tests are based on the pypy test environment, so::
 
 is what you should use. If you don't have py.test, get it it's part of pypy!
 It's really good!
-<<<<<<< HEAD
-=======
-
-Windows (beta)
-==============
-
-Above all pyoidc is developed and used in unix environments. In order to make it easier for people to use it in windows
-environments a install script named install.bat has been developed which installs most of the necessary dependencies.
-There are still some applications which is not included in .bat file like Python, Git, PyOpenSSL and Microsoft
-Visual C++ Compiler.
-
-NOTE: The script has been developed and used on windows 10.
-
-A complete zip file containing all det executable files and the install script could be downloaded here:
-https://dirg.org.umu.se/static/pyoidc_windows_install_full.zip
-
-If you only want the install script it could be downloaded here:
-https://dirg.org.umu.se/static/pyoidc_windows_install_script.zip
-
-Start of by installing the program in the "Executables" folder. In order for it to work appropriate install the
-applicaions in the following order.
-
-1. python-2.7.9 		    (https://www.python.org/downloads/)
-2. Git-1.9.5-preview 		(http://git-scm.com/downloads)
-  2.1 On the "ajusting your path environment" page select "Use Git from the windows command prompt"
-3. PyOpenSSL-0.13.1 		(https://pypi.python.org/pypi/pyOpenSSL/0.13.1#downloads)
-4. VCForPython27 		    (http://aka.ms/vcpython27)
-
-After installing the executable files go back to the root folder and run the file named install.bat
-
-NOTE: If you are planing to start the .bat file from a command prompt make sure the command prompt where started after installing Git-1.9.5-preview.
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
diff --git a/doc/make.bat b/doc/make.bat
@@ -33,11 +33,8 @@ if "%1" == "help" (
 	echo.  texinfo    to make Texinfo files
 	echo.  gettext    to make PO message catalogs
 	echo.  changes    to make an overview over all changed/added/deprecated items
-<<<<<<< HEAD
-=======
 	echo.  xml        to make Docutils-native XML files
 	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 	echo.  linkcheck  to check all external links for integrity
 	echo.  doctest    to run all doctests embedded in the documentation if enabled
 	goto end
@@ -49,8 +46,6 @@ if "%1" == "clean" (
 	goto end
 )
 
-<<<<<<< HEAD
-=======
 
 %SPHINXBUILD% 2> nul
 if errorlevel 9009 (
@@ -65,7 +60,6 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 if "%1" == "html" (
 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 	if errorlevel 1 exit /b 1
@@ -121,15 +115,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-<<<<<<< HEAD
 	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyjwkest.qhcp
 	echo.To view the help file:
 	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyjwkest.ghc
-=======
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyoidc.qhcp
-	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyoidc.ghc
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 	goto end
 )
 
@@ -157,8 +145,6 @@ if "%1" == "latex" (
 	goto end
 )
 
-<<<<<<< HEAD
-=======
 if "%1" == "latexpdf" (
 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
 	cd %BUILDDIR%/latex
@@ -179,7 +165,6 @@ if "%1" == "latexpdfja" (
 	goto end
 )
 
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 if "%1" == "text" (
 	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
 	if errorlevel 1 exit /b 1
@@ -238,8 +223,6 @@ results in %BUILDDIR%/doctest/output.txt.
 	goto end
 )
 
-<<<<<<< HEAD
-=======
 if "%1" == "xml" (
 	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
 	if errorlevel 1 exit /b 1
@@ -256,5 +239,4 @@ if "%1" == "pseudoxml" (
 	goto end
 )
 
->>>>>>> d8858378e9d3351804dba5654444cc23b9e1c07c
 :end
