Refactor docs into a different theme, improve nav (#319)

* Refactor docs into a different theme, improve nav

* Amendments to PR

.gitignore

@@ -45,7 +45,8 @@ src/build
 
 # Virtual Environments
 /env*
-
+.venv/
+docs/_build/
 # Visual Studio Files
 /.vs/*
 /tests/.vs/*

docs/conf.py

@@ -12,6 +12,7 @@
 # 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.
 #
+from datetime import date
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))
@@ -20,7 +21,7 @@
 # -- Project information -----------------------------------------------------
 
 project = u'MSAL Python'
-copyright = u'2018, Microsoft'
+copyright = u'{0}, Microsoft'.format(date.today().year)
 author = u'Microsoft'
 
 # The short X.Y version
@@ -77,13 +78,18 @@
 # a list of builtin themes.
 #
 # html_theme = 'alabaster'
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 
 # 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 = {
+     "light_css_variables": {
+         "font-stack": "'Segoe UI', SegoeUI, 'Helvetica Neue', Helvetica, Arial, sans-serif",
+         "font-stack--monospace": "SFMono-Regular, Consolas, 'Liberation Mono', Menlo, Courier, monospace",
+     },
+}
 
 # 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,
@@ -176,4 +182,4 @@
 epub_exclude_files = ['search.html']
 
 
-# -- Extension configuration -------------------------------------------------
+# -- Extension configuration -------------------------------------------------

docs/index.rst

@@ -1,17 +1,13 @@
-.. MSAL Python documentation master file, created by
-   sphinx-quickstart on Tue Dec 18 10:53:22 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. This file is also inspired by
-   https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example
-
-Welcome to MSAL Python's documentation!
-=======================================
+MSAL Python documentation
+=========================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
+   :hidden:
+
+   MSAL Documentation <https://docs.microsoft.com/en-au/azure/active-directory/develop/msal-authentication-flows>
+   GitHub Repository <https://github.com/AzureAD/microsoft-authentication-library-for-python>
 
 You can find high level conceptual documentations in the project
 `README <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_
@@ -22,9 +18,8 @@ and
 
 The documentation hosted here is for API Reference.
 
-
-PublicClientApplication and ConfidentialClientApplication
-=========================================================
+API
+===
 
 MSAL proposes a clean separation between
 `public client applications and confidential client applications
@@ -35,31 +30,22 @@ with different methods for different authentication scenarios.
 
 PublicClientApplication
 -----------------------
+
 .. autoclass:: msal.PublicClientApplication
    :members:
+   :inherited-members:
 
 ConfidentialClientApplication
 -----------------------------
-.. autoclass:: msal.ConfidentialClientApplication
-   :members:
-
 
-Shared Methods
---------------
-Both PublicClientApplication and ConfidentialClientApplication
-have following methods inherited from their base class.
-You typically do not need to initiate this base class, though.
-
-.. autoclass:: msal.ClientApplication
+.. autoclass:: msal.ConfidentialClientApplication
    :members:
-
-   .. automethod:: __init__
-
+   :inherited-members:
 
 TokenCache
-==========
+----------
 
-One of the parameter accepted by
+One of the parameters accepted by
 both `PublicClientApplication` and `ConfidentialClientApplication`
 is the `TokenCache`.
 
@@ -71,11 +57,3 @@ See `SerializableTokenCache` for example.
 
 .. autoclass:: msal.SerializableTokenCache
    :members:
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
-

docs/requirements.txt

@@ -0,0 +1,2 @@
+furo
+-r ../requirements.txt