Browse Source

Updated docs.

hotfix/merge
Marcos Pereira 7 years ago
parent
commit
938fe4a41c
  1. 4
      docs/Makefile
  2. 36
      docs/make.bat
  3. 8
      docs/source/conf.py
  4. 2
      docs/source/index.md

4
docs/Makefile

@ -5,8 +5,8 @@
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = python-keycloak
SOURCEDIR = .
BUILDDIR = _build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:

36
docs/make.bat

@ -1,36 +0,0 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=python-keycloak
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd

8
docs/conf.py → docs/source/conf.py

@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
#
# python-keycloak documentation build configuration file, created by
# sphinx-quickstart on Tue Aug 15 10:44:03 2017.
# sphinx-quickstart on Tue Aug 15 11:02:59 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
@ -31,7 +31,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -40,7 +40,7 @@ templates_path = ['_templates']
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = '.md'
# The master toctree document.
master_doc = 'index'
@ -69,7 +69,7 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

2
docs/index.rst → docs/source/index.md

@ -1,5 +1,5 @@
.. python-keycloak documentation master file, created by
sphinx-quickstart on Tue Aug 15 10:44:03 2017.
sphinx-quickstart on Tue Aug 15 11:02:59 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Loading…
Cancel
Save