Commit 31ca573e authored by cdanger's avatar cdanger

DOC:

- Added support for Markdown
- Added Release notes, and Features section
parent 88fa0f0e
/.Features.md.html
This diff is collapsed.
This diff is collapsed.
==================================================
AuthZForce - Installation and Administration Guide
==================================================
=====================================
Installation and Administration Guide
=====================================
This guide provides the procedure to install the `AuthZForce server <https://github.com/authzforce/server>`_, including system requirements and troubleshooting instructions.
......
=============
Release Notes
=============
The release notes are available on our `GitHub release page <https://github.com/authzforce/server/releases/tag/release-5.4.1>`_.
\ No newline at end of file
This diff is collapsed.
# -*- coding: utf-8 -*-
#
# AuthZForce documentation build configuration file, created by
# AuthzForce documentation build configuration file, created by
# sphinx-quickstart on Wed Sep 30 14:53:18 2015.
#
# This file is execfile()d with the current directory set to its
......@@ -19,6 +19,7 @@ import shlex
# Chaning verbatim (source code listings) font size
from sphinx.highlighting import PygmentsBridge
from pygments.formatters.latex import LatexFormatter
from recommonmark.parser import CommonMarkParser
class CustomLatexFormatter(LatexFormatter):
def __init__(self, **options):
......@@ -71,8 +72,9 @@ 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'
source_suffix = ['.rst', '.md']
source_parsers = {'.md': CommonMarkParser}
# The encoding of source files.
#source_encoding = 'utf-8-sig'
......@@ -81,8 +83,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'AuthZForce CE'
copyright = u'2015-2016, Thales Services'
project = u'AuthzForce CE'
copyright = u'2015-2017, Thales Services'
author = u'Cyril Dangerville, Thales Services'
# The version info for the project you're documenting, acts as replacement for
......@@ -92,7 +94,7 @@ author = u'Cyril Dangerville, Thales Services'
# The short X.Y version.
version = '5.4.1'
# The full version, including alpha/beta/rc tags.
release = '5.4.1'
release = '5.4.1e'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -236,7 +238,7 @@ html_use_index = True
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'AuthZForcedoc'
htmlhelp_basename = 'AuthzForcedoc'
# -- Options for LaTeX output ---------------------------------------------
......@@ -259,7 +261,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'AuthZForce.tex', u'AuthZForce CE',
(master_doc, 'AuthzForce.tex', u'AuthzForce CE',
u'Cyril Dangerville, Thales Services', 'manual'),
]
......@@ -289,7 +291,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'authzforce', u'AuthZForce CE',
(master_doc, 'authzforce', u'AuthzForce CE',
[author], 1)
]
......@@ -303,8 +305,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AuthZForce CE', u'AuthZForce CE',
author, 'AuthZForce CE', 'AuthZForce Community Edition',
(master_doc, 'AuthzForce CE', u'AuthzForce CE',
author, 'AuthzForce CE', 'AuthzForce Community Edition',
'Miscellaneous'),
]
......
......@@ -20,6 +20,8 @@ This project is part of `FIWARE`_. You will find more information about this FIW
:maxdepth: 10
Introduction.rst
ReleaseNotes.rst
Features.rst
InstallationAndAdministrationGuide.rst
UserAndProgrammersGuide.rst
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment