Updating layout and templates

Author: jleni

AUTHORS.md

@@ -0,0 +1,5 @@
+==========
+Developers
+==========
+
+- Quantum Resistant Ledger Developers

AUTHORS.rst

@@ -0,0 +1,9 @@
+=========
+Changelog
+=========
+
+Version 0.X
+===========
+
+- DESCRIBE IMPORTANT CHANGES
+

CHANGES.md

@@ -1,2 +1,2 @@
 .. _authors:
-.. include:: ../AUTHORS.rst
+.. include:: ../AUTHORS.md

CHANGES.rst

@@ -1,2 +1,2 @@
 .. _changes:
-.. include:: ../CHANGES.rst
+.. include:: ../CHANGES.md

docs/authors.rst

@@ -21,6 +21,10 @@
 # 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('.'))
+import sphinx_rtd_theme
+from recommonmark.parser import CommonMarkParser
+from recommonmark.transform import AutoStructify
+
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 if on_rtd:
     import inspect
@@ -57,7 +61,7 @@
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
@@ -120,15 +124,16 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'bizstyle'
+html_theme = "sphinx_rtd_theme"
 
 # 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 = {}
+html_theme_options = {
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = []
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -201,25 +206,24 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'core-doc'
 
-
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-# 'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-# 'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-# 'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, targematplot name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'user_guide.tex', u'QRL Documentation',
-   u'The Quantum Resistant Ledger', 'manual'),
+    ('index', 'user_guide.tex', u'QRL Documentation',
+     u'The Quantum Resistant Ledger', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -247,9 +251,20 @@
 intersphinx_mapping = {
     'sphinx': ('http://sphinx.pocoo.org', None),
     'python': ('http://docs.python.org/' + python_version, None),
-#    'matplotlib': ('http://matplotlib.sourceforge.net', None),
-#    'numpy': ('http://docs.scipy.org/doc/numpy', None),
-#    'sklearn': ('http://scikit-learn.org/stable', None),
-#    'pandas': ('http://pandas.pydata.org/pandas-docs/stable', None),
-#    'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
+    #    'matplotlib': ('http://matplotlib.sourceforge.net', None),
+    #    'numpy': ('http://docs.scipy.org/doc/numpy', None),
+    #    'sklearn': ('http://scikit-learn.org/stable', None),
+    #    'pandas': ('http://pandas.pydata.org/pandas-docs/stable', None),
+    #    'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
 }
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'enable_eval_rst': True,
+    }, True)
+    app.add_transform(AutoStructify)

docs/changes.rst

@@ -1,18 +1,13 @@
 ===
-QRL
+Quantum Resistant Ledger
 ===
 
 This is the documentation of **QRL**.
 
 .. note::
 
     This is the main page of your project's `Sphinx <http://sphinx-doc.org/>`_
-    documentation. It is formatted in `reStructuredText
-    <http://sphinx-doc.org/rest.html>`__. Add additional pages by creating
-    rst-files in ``docs`` and adding them to the `toctree
-    <http://sphinx-doc.org/markup/toctree.html>`_ below. Use then
-    `references <http://sphinx-doc.org/markup/inline.html>`__ in order to link
-    them from this page, e.g. :ref:`authors <authors>` and :ref:`changes`.
+    documentation.
 
     It is also possible to refer to the documentation of other Python packages
     with the `Python domain syntax
@@ -48,7 +43,8 @@ Contents
    Authors <authors>
    Changelog <changes>
    Module Reference <api/modules>
-
+   Blog <https://medium.com/the-quantum-resistant-ledger>
+   QRL Whitepaper <https://github.com/theQRL/Whitepaper/blob/master/QRL_whitepaper.pdf>
 
 Indices and tables
 ==================